gpss

A newer version of this documentation is available. Use the version menu above to view the most up-to-date release of the Greenplum 6.x documentation.

gpss

Start an instance of a Greenplum Stream Server.

Synopsis

gpss [--debug-port portnum ] [-l | --log-dir directory] [config.json]

gpss {-h | --help}

gpss --version 

Description

The gpss utility starts an instance of the Greenplum Database Stream Server (GPSS). When you run the command, you optionally provide a JSON-formatted configuration file that defines run properties such as the GPSS server listen address, gpfdist host and port number, and encryption certificate and key files. You can also specify the directory to which GPSS writes its log files.

When started, gpss waits indefinitely for client job requests. A single GPSS instance can service requests from multiple clients. Refer to the gpsscli reference page for more information about client job commands.

Note: gpss keeps track of the loading progress of client jobs in memory. When you stop a GPSS server instance, you lose all registered jobs. You must re-submit any previously-submitted jobs that you require after you restart the GPSS instance. gpss will resume a job from the last load offset.

Options

config.json
The JSON-formatted configuration file that defines the run properties of a GPSS service instance. If the filename provided is not an absolute path, GPSS assumes that the file system location is relative to the current working directory. Refer to gpss.json for the format and content of the properties that you specify in this file.
If you do not provide a GPSS configuration file, Greenplum Database starts gpss on default port 5000 on host 127.0.0.1, starts gpfdist on default port 8080 on the local host address identified by the output of the hostname command, and does not use encryption.
--debug-port portnum
When you specify this option, gpss includes debug information such as the source code file and line number in messages it writes to stdout. The utility also starts a debug server at the port identified by portnum on the local host (127.0.0.1); additional debug information including the call stack and performance statistics is available from the server.
-l | --log-dir directory
Specify the directory to which GPSS writes log files. GPSS must have write permission to the directory. GPSS creates the log directory if it does not exist.

If you do not provide this option, GPSS writes gpss log files to the $HOME/gpAdminLogs directory.

-h | --help
Show command help, and then exit.
--version
Show command version, and then exit.

Examples

Start a Greenplum Stream Server instance in the background, specifying a log directory of /home/gpadmin/logs.gpss, and using the run properties defined in a configuration file named gpsscfg.json located in the current directory. Also start a GPSS debug server on port number 8915:

$ gpss --debug-port 8915 --log-dir /home/gpadmin/logs.gpss gpsscfg.json &

View the debug information available from the GPSS debug server:

$ curl http://127.0.0.1:8915/debug/pprof/

See Also

gpss.json, gpsscli