Couchbase agent

Prerequisites

  • For prerequisite checks for agent installation, see Prerequisite checks for agent installation.
  • Couchbase cluster host
  • Couchbase user credentials (user, password)
  • Couchbase cluster management and query port access
  • agent required access of all nodes through Couchbase user. (agent should be able to curl to the node, management, query port)
    • curl -u [user]:[password] http://[localhost]:8091/pools
    • curl -u [user]:[password] http://localhost:8093/admin/vitals
  • URL/IP of the SixthSense collector (your tenant URL which will be provided by Customer Support).
  • Access token from the SixthSense portal. For accessing the token, see Accessing your Access Token.

Downloading the agent

For Windows and Linux based servers, use the following link.

curl --header "PRIVATE-TOKEN:{TOKEN}" --output meter-agent.zip "https://artifacts-observability.sixthsense.rakuten.com/api/v4/projects/32/packages/generic/METER-AGENT/latest/meter-agent.zip"

Configuring the Couchbase agent

Following is a sample yaml file to configure the agent.

sixthsense:
service_name: <couchbase-service-name>
# Login to Sixthsense UI --> Go to Settings on Side Navbar --> Copy Access Token
authentication: <authentication>
# debug|error|info
logging: debug
sixthsense_backend: <collector-host>
# SSL connection with backend true|false
secure: false
# MY | ES | MS | CB | OR
type: CB
hosturl: <couchbase host>
hostProtocol: <http/https>
user: <couchase-user>
password: <couchbase-password>
port: 8091 #management port
n1qlport: 8093 #query port
queryLimit: 10 #no of queries
queryThresholdTime: 1 #millisecond

Running the agent

For Linux:

The agent can be started by running the executable

./sixthsense-couchbase-agent <config-file.yaml>

For Windows:

  1. Extract meter-agent.zip file and edit the configuration in the yaml file with cluster information.

  2. Open the command prompt with run as Administrator and enter the following command:

    nssm.exe install “Service_Name”

  3. In the NSSM service installer screen, the Application tab is selected by default.

  4. Enter the following details:

  • Path: meter-agent.exe full path
  • Startup directory: folder path
  • Arguments: yaml full name
  1. Click the Details tab.
  2. Enter the following details:
  • Display name: service display name
  • Description: service description
  • Setup type: select type for setup such as automatic.
  1. Click the Log on tab.
  2. Select Local System account radio button.
  3. Select Allow service to interact with desktop check box.
  4. Click Install service.