Cassandra agent

Prerequisites

  • For prerequisite checks for agent installation, see Prerequisite checks for agent installation.
  • 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.
  • For information about supported agent versions and framework, see Supported agents.
  • 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 version 4.4.0 (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.0/meter-agent.zip"
note

Agent depends on the OS and architecture.

Configuring the agent

  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
    • 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
  • SSL connection with backend true|false
    • secure: true
    • (For One Cloud) secure:false
  • hostname: hostname
  • port: port
  • user: db_user
  • password: db_user_password
  • keyspace: keyspace_name
  • queryLimit: 10 (no of queries)
  • queryThresholdTime: 1 #millisecond

To enable the query on the cassandra database, perform the following:

  1. Login to the linux machine
  2. Run "nodetool settraceprobability 1;"
  3. Run cqlsh
  4. Create a DB and run the query inside the created DB

Running the agent

For Linux:

Run Cassandra agent in the terminal using the following commnad.

./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

For Windows:

  1. Extract CassandraDB_Windows.zip file.
  2. Edit configuration in the yaml file as follows.
  3. Open command prompt with run as Administrator and enter following command:
nssm.exe install “Service_Name”
  1. In the NSSM service installer window, the Application tab is selected by default.
  2. 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.

Editing the configuration in the yaml file

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
note

It supports instance name also with hostname.