Couchbase agent


  • 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

curl --header "PRIVATE-TOKEN:{{PACKAGE_TOKEN}}" --output couchbase-agent "{{AGENT_VERSION}}/"

Configuring the agent

Following is a sample yaml file to configure the agent.

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 on Linux

The agent can be started by running the executable

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

Running the agent on Windows

  1. Extract 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 popup, add following details:

    1. Path: meter-agent.exe full path
    2. Startup directory: folder path
    3. Arguments: yaml full name
    4. Service Display name
    5. Description
    6. Allow service to interact with desktop