Installing the agent

Install the SixthSense agent for Windows by using the following information and procedure.

Analytics Agent/Exporter (latest)

Prerequisites

  • SixthSense Analytics Agent. For more information, see Installing the Sixthsense Analytics Agent.
  • URL/IP of the Sixthsense backend collector (the tenant URL provided by Customer Support)
  • Access token provided by Customer Support.
  • PACKAGE_TOKEN - Access Token required for downloading SixthSense Package provided by Customer Support.
  • PACKAGE_TOKEN_USERNAME - Username for Access Token provided by Customer Support.
  • TOKEN - Access Token from the SixthSense portal Settings page.
  • For supported agent versions and framework, see Anlaytics agents.

Downloading the Sixthsense Analytics agent version 2.0.0 (latest)

  1. Download latest ss_analytics_exporter.zip folder using token provided by Customer Support.
curl --header "PRIVATE-TOKEN:{{TOKEN}}" --output ss_analytics_exporter.zip "https://artifacts-observability.sixthsense.rakuten.com/api/v4/projects/32/packages/generic/AnalyticsExporter/v2.0.0/ss_analytics_exporter.zip"
  1. Unzip the release zip folder and place it in the agent directory.

The agent folder structure is as follows:

Agent Folder Structure

Installing the Sixthsense Analytics agent

  1. Update ss-config.yaml as mentioned below.
global_settings:
# URL of the SixthSense backend
# For connectivity to backend using intra public network: 133.237.176.44:80 or grpc-collector-observability.sixthsense.rakuten.com:443
# For connectivity to backend using onecloud private network: 100.99.116.221:80
sixthsense_backend: <your_backend_url>
# To establish communication between the Infrastructure Agent and the SixthSense backend, authentication is performed using an access token. Login to Sixthsense UI --> On Side Navigation bar Go to Settings --> Copy Access Token.
authentication: <your_authentication_token>
# proxy url with http or https as prefix
# Eg: http://127.0.0.1:80
# Eg: https://127.0.0.1:80
proxyURL: <proxyurl:proxyport>
# Enables TLS encryption for secure communication with the backend. Allowed values: true|false.
tlsEnabled: false
# Used to select HTTP/2 or HTTP/1.1 ( If true then HTTP/2 is used, If false then HTTP/1.1 is used)
forceAttemptHTTP2: false
# Sets the memory usage cap (in MB) for the agent to prevent overconsumption of system resources.(Optional)
# maxMemoryUsageLimit: 1024 # MB
services:
- # A service name groups together all scripts that run the same service.
service_name: <your_service_name>
# Script name where your metrics can be extracted and executed for this service.
script_name: <your_script_name>
# Specifies the directory or file path where logs are stored.
logPath: <path_to_analytics_agent>/logs/<your_service_name>.log
# debug|error|info
logging: debug
# Poll frequency (in seconds) to collect metrics.
cronCycle: 60
# Metrics endpoint URL/API
url: http://localhost:8091/metrics
# Username for basic auth (optional)
# user: <your_username>
# Password for basic auth (optional)
# password: <your_password>
# Path to a custom metrics file (optional)
# metricFile: metrics.json
# Maximum number of lines to scrape (max 1000)
maxScrapLineLimit: 1000
- service_name: <your_service_name>
script_name: <your_script_name>
logging: debug
cronCycle: 60
url: http://localhost:8091/metrics
# Username for basic auth (optional)
# user: <your_username>
# Password for basic auth (optional)
# password: <your_password>
# Path to a custom metrics file (optional)
# metricFile: metrics.json
logPath: logs/service2.log
maxScrapLineLimit: 1000 # max limit is 1000 from metrics.json

Running the Analytics agent for windows

  1. Extract ss_analytics_exporter.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: ss-analytics-exporter-windows-<arch>.exe (exe path)
  • Startup directory: <path_to_analytics_exporter>/ss-analytics-exporter-2.0.0 (folder path)
  1. Click the Details tab.
  2. Enter the following details:
  • Display name: service display name
  • Description: service description
  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.

Running the Analytics agent for Linux with nohup

To start the agent, use the following command.

nohup ./<path_to_analytics_exporter>/ss-analytics-exporter-2.0.0/ss-analytics-exporter-linux-<arch> &

In case of network restrictions, append proxy to the nohup command to enable connection to sixthsense-backend.

nohup HTTPS_PROXY=proxy-server:port <path_to_analytics_exporter>/ss-analytics-exporter-2.0.0/ss-analytics-exporter-linux-<arch> &
  • nohup - to start with logs, command output logs will be stored in nohup.out file
  • "&" - to start as background process

Running the Analytics agent for Darwin/MacOS

To start the agent, use the following command.

./<path_to_analytics_exporter>/ss-analytics-exporter-2.0.0/ss-analytics-exporter-linux-<arch> &
  • "&" - to start as background process

Analytics via Infra Agent (Older approach)

Prerequisites

  • OS: Windows Server versions 2008R2 and later, and desktop Windows version 7 and later
  • SixthSense Windows Analytics Agent. For more information, see Installing the Agent.
  • URL/IP of the Sixthsense backend collector (the tenant URL provided by Customer Support)
  • Access token provided by Customer Support.
  • PACKAGE_TOKEN - Access Token required for downloading SixthSense Package provided by Customer Support.
  • PACKAGE_TOKEN_USERNAME - Username for Access Token provided by Customer Support.
  • TOKEN - Access Token from the SixthSense portal Settings page.
  • For supported agent versions and framework, see Anlaytics agents.

Downloading the infra agent version 2.2.2

  1. Download latest ss_windows_infra_agent-<version_no>.zip release folder provided by Customer Support.
curl --header "PRIVATE-TOKEN:{{TOKEN}}" --output ss_windows_infra_agent.zip "https://artifacts-observability.sixthsense.rakuten.com/api/v4/projects/15/packages/generic/sixthsense-infra-agent/2.2.2/ss_windows_infra_agent.zip"
  1. Unzip the release zip folder and place it in the agent directory.

The agent folder structure is as follows:

Agent Folder Structure

Installing the infra agent

  1. Update ss_windows_infra_agent_config.yaml as in the instructions mentioned in config file Agent resource usage.
# sixthsense-infra-agent can be configured via yaml or environment variables
#
# Note: Environment Variables are given higher priority over yaml file
#
# Following are the environment variables that can be set:
# ENV VARIABLE CORRESPONDS TO
# SS_SERVICE_NAME service_name
# SS_AUTHENTICATION authentication
# SS_BACKEND sixthsense_backend
# SS_LOGGING logging
# SS_SECURE secure
# SS_DEFAULTCOLLECTOR default_collectors
# SS_DEFAULTCOLLECTOR_PLACEHOLDER default_collectors_placeholdersixthsense
service_name: <custom_service_name>
# Login to the SixthSense portal > Go to Settings from the left navigation bar > Copy Access Token
authentication: <service_auth_token>
# debug|error|info
logging: info
sixthsense_backend: <sixthsense_backend_collector>
# For connectivity to backend using intra public network: 133.237.176.44:80
# For connectivity to backend using onecloud private network: 100.99.116.221:80
# SSL connection with backend true|false
secure: true
# For OneCloud Platform use secure: false
#cpu,cs,logical_disk,net,os,service,system,textfile
default_collectors: "cpu,cs,logical_disk,net,os,memory,system,iis,process,cpu_info"
default_collectors_placeholder: "[defaults]"
enabled: cpu,cs,net,service`

Example of executions_config.yaml file for configuring powershell script path.

sixthsensescheduler:
name: Script_Monitoring
enabled: true
sixthsense_scheduler_backend: <collector_url>
secure: true
access_token: <authentication_token>
logging: info
cronCycle: "*/1 * * * *"
# ----------- Execution task configuration -- --------------
scripts:
- type: powershell
service_name: activeDirectory_Prod1
enabled: true
timeout: 15
script_path:
- 'C:/path/AD.ps1'
- 'C:/path/NewFile.ps1'
  1. After configuring the the connection details, start the Agent service from services. The metrics will be available on the dashboard.

Running the agent for windows

  1. Extract ss_windows_infra_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: windows.exporter.exe full path
  • Startup directory: folder path
  1. Click the Details tab.
  2. Enter the following details:
  • Display name: service display name
  • Description: service description
  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.