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.
  • For information about supported agent versions and framework, see Supported agents.

Downloading the agent version 4.4.5 (latest)

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/v4.4.5/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>
# For GCP: grpc-collector-observability.sixthsense.rakuten.com:443
# (One Cloud) For connectivity to backend using intra public network: 133.237.176.44:80
# (One Cloud) For connectivity to backend using onecloud private network: 100.99.116.221:80
# (For One Cloud) secure: false
# SSL connection with backend true|false
secure: true
# 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. Register DBM agent as a Service in Windows. Type in the following command in cmd:
sc create "<Service Name>" binPath= "\"<path_to_exe>.exe\" -config \"<path_to_config>.yaml\"" start= auto

Example:

sc create "MeterAgent_couchbase" binPath= "\"C:\ Downloads\meter-agent\Meter-Agent-v4.4.5\Windows\meter-agent-v4.4.5.exe\" -config \"C:\ Downloads\meter-agent\Meter-Agent-v4.4.5\Configs\ss-postgresql-config.yaml\"" start= auto

  1. Confirm whether the service is registered by opening Services and search for the Service Name with which you've registered.

  2. Run the service by opening the Services again and look for Service name > Start or sc start <service_name>.

Example: sc start MeterAgent_couchbase