Please use the form below to provide your feedback. Because your feedback is valuable to us, the information you submit in this form is recorded in our issue tracking system (JIRA), which is publicly available. You can track the status of your feedback using the ticket number displayed in the dialog once you submit the form.

operational-insights

  • reference

The operational-insights command is used to start, stop, and retrieve status on a non-root-installed node, on any supported Linux platform.

Syntax

operational-insights [
          [ --start ]
          [ --status | -s ]
          [ --stop | -k ]
          [ --help | -h ]
          [ --version | -v ]
         ]

Description

The operational-insights command is used to control aspects of an Operational Insights node that has been installed, on a supported Linux platform, by means of the non-root procedure. This command cannot be used to control a node installed by the standard, package-based install procedure, which runs Operational Insights as the operational-insights service.

The --start flag causes the non-root node to start. This is the default option, and is invoked if no flag is specified.

The --status flag returns status on the non-root node, indicating whether it has been started, or has been stopped.

The --stop flag causes a running non-root node to stop.

The --help flag prints help text to the console.

The --version flag prints to the console the version number of the non-root node.

Examples

The following examples show how the operational-insights command and its parameters can be used. The examples assumes that the current working directory is <install-location>/opt/couchbase/bin.

Start

To start a non-root node, enter the following command:

./operational-insights --start

This starts a non-root node. No output is displayed.

Get Status

To get status on whether a non-root Operational Insights is running, enter the following command.

./operational-insights --status

If a non-root Operational Insights is running, the following is displayed:

Operational Insights is running

If a non-root-installed node is not running, the following is displayed:

Operational Insights is not running

Stop

To stop a non-root node, enter the following command:

./operational-insights --stop

This stops a running, non-root node. The output might appear as follows:

2020-06-30 09:33:03 cb_dist: terminating with reason: shutdown

If no non-root node was running, no output is displayed.

Get Version Number

To get the version number of the non-root node, enter the following:

./operational-insights --version

If successful, the command prints the version number and edition of the non-root node, as follows:

Operational Insights 3.0.0-nnnn (EE)

See Also

Links to standard, package-based install procedures are provided in Install on Linux.