Cassandra agent

Prerequisites

  • 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 under Getting started with the Observability Portal.
  • Cassandra agent version 1.0.0
  • database details (host name, port, database name, database user credentials).
  • Package token to download agent which will be provided by Customer Support.
  • Database User Permissions: Grant SELECT permission for all keyspaces to <db_user>.

Downloading the agent

For linux based servers, use the following URL to download the agent.

curl --header "PRIVATE-TOKEN:{{PACKAGE_TOKEN}} " --output CassandraDB_Linux.zip "https://artifacts-observability.sixthsense.rakuten.com/api/v4/projects/32/packages/generic/Cassandra-Agent/v1.0/CassandraDB_Linux.zip""

For Windows based servers, use the following URL to download the agent.

curl --header "PRIVATE-TOKEN:{{PACKAGE_TOKEN}}" --output CassandraDB_windows.zip "https://artifacts-observability.sixthsense.rakuten.com/api/v4/projects/32/packages/generic/Cassandra-Agent/v1.0/CassandraDB_Windows.zip"
note

Agent depends on the OS and architecture.

Configuring the agent for Linux

  1. Extract CassandraDB_Linux.zip file.
  2. Edit the configuration in yaml file as follows.

In the yaml file, add the following configuration details:

  • service_name: Service name will display on UI
  • authentication: Get access token from dashboard under setting
  • sixthsense_backend: Backend collector URL
  • hostname: hostname
  • port: port
  • user: db_user
  • password: db_user_password
  • keyspace: keyspace_name
  • queryLimit: 10 (no of queries)
  • queryThresholdTime: 1 #millisecond

Running the agent

Use the following command to run the agent.

./meter-agent-linux path/to/config/ss-cassandra-config.yaml

In case of network restrictions, pass proxy to the meter-agent process so that you can connect to the sixthsense-backend.

HTTPS_PROXY=proxy-server:port./meter-agent-linux path/to/config/ss-cassandra-config.yaml

Configuring the agent for Windows

  1. Extract CassandraDB_Windows.zip file.
  2. Edit configuration in the yaml file as follows.

Open command prompt with run as Administrator and enter following command:

nssm.exe install “Service_Name”
  1. In the NSSM service installer window, fill in the following details.
  • Path: meter-agent.exe full path
  • Startup directory: folder path
  • Arguments: yaml full name
  • Service Display name
  • Description
  • Allow service to interact with desktop

In the yaml file, add the following configuration details.

  • service_name: Service name will display on UI
  • authentication: Get access token from dashboard under setting
  • sixthsense_backend: Backend collector URL
  • hostname: hostname
  • port: port
  • user: db_user
  • password: db_user_password
  • keyspace: keyspace_name