Skip to main content

OpenTSDB

OpenTSDB is a distributed, scalable Time Series Database (TSDB). OpenTSDB allows store, index, and serve metrics collected from computer systems at a large scale, and make this data easily accessible and graphable.

Scope of Support

Currently, Nobl9 does not support the Direct configuration for the OpenTSDB integration.

Authentication

Nobl9 integration with OpenTSDB does not support an authentication and access control system. The API calls are open to the public.

If you would like to limit access to OpenTSDB, you must use network ACLs or firewalls. OpenTSDB is meant to be run behind a user’s private environment and is not public-facing.

Adding OpenTSDB as a Data Source in the UI

To add OpenTSDB as a data source in Nobl9 using the Agent connection method, follow these steps:

  1. Navigate to Integrations > Sources.
  2. Click the button.
  3. Click the relevant Source icon.
  4. Choose a relevant connection method (Agent or Direct), then configure the source as described below.

OpenTSDB Agent

Agent Configuration in the UI

Follow the instructions below to configure your OpenTSDB Agent:

  1. Enter a URL to connect to your data source.
  1. Select a Project.
    Specifying a Project is helpful when multiple users are spread across multiple teams or projects. When the Project field is left blank then object is assigned to project default.
  2. Enter a Display Name.
    You can enter a friendly name with spaces in this field.
  3. Enter a Name.
    The name is mandatory and can only contain lowercase, alphanumeric characters and dashes (for example, my-project-name). This field is populated automatically when you enter a display name, but you can edit the result.
  4. Enter a Description.
    Here you can add details such as who is responsible for the integration (team/owner) and the purpose of creating it.
  5. Click the Add Data Source button.

Agent Using CLI - YAML

The YAML for setting up an Agent connection to OpenTSDB looks like this:

apiVersion: n9/v1alpha
kind: Agent
metadata:
name: opentsdb
displayName: OpenTSDB Agent # optional
project: opentsdb
spec:
sourceOf:
- Metrics
- Services
opentsdb:
url: http://instance-example.OpenTSDB.com

Important notes:

  • url - base URL that points to your OpenTSDB instance
warning

You can deploy only one Agent in one YAML file by using the sloctl apply command.

Deploying OpenTSDB Agent

When you add the data source, Nobl9 automatically generates a Kubernetes configuration and a Docker command line for you to use to deploy the Agent. Both of these are available in the web UI, under the Agent Configuration section. Be sure to swap in your credentials.

If you use Kubernetes, you can apply the supplied YAML config file to a Kubernetes cluster to deploy the Agent. It will look something like this:

# DISCLAIMER: This deployment description contains only the fields necessary for the purpose of this demo.
# It is not a ready-to-apply k8s deployment description, and the client_id and client_secret are only exemplary values.

apiVersion: v1
kind: Secret
metadata:
name: nobl9-agent-nobl9-dev-opentsdb-opentsdb-test
namespace: default
type: Opaque
stringData:
client_id: "unique_client_id"
client_secret: "unique_client_secret"
---
apiVersion: apps/v1
kind: Deployment
metadata:
name: nobl9-agent-nobl9-dev-opentsdb-opentsdb-test
namespace: default
spec:
replicas: 1
selector:
matchLabels:
nobl9-agent-name: opentsdb-test
nobl9-agent-project: opentsdb
nobl9-agent-organization: nobl9-dev
template:
metadata:
labels:
nobl9-agent-name: opentsdb-test
nobl9-agent-project: opentsdb
nobl9-agent-organization: nobl9-dev
spec:
containers:
- name: agent-container
image: nobl9/agent:latest
resources:
requests:
memory: "350Mi"
cpu: "0.1"
env:
- name: N9_CLIENT_ID
valueFrom:
secretKeyRef:
key: client_id
name: nobl9-agent-nobl9-dev-opentsdb-opentsdb-test
- name: N9_CLIENT_SECRET
valueFrom:
secretKeyRef:
key: client_secret
name: nobl9-agent-nobl9-dev-opentsdb-opentsdb-test
# The N9_METRICS_PORT is a variable specifying the port to which the /metrics and /health endpoints are exposed.
# The 9090 is the default value and can be changed.
# If you don’t want the metrics to be exposed, comment out or delete the N9_METRICS_PORT variable.
- name: N9_METRICS_PORT
value: "9090"

Creating SLOs with OpenTSDB

Creating SLOs in the UI

Follow the instructions below to create your SLOs with OpenTSDB in the UI:

  1. Navigate to Service Level Objectives.

  2. Click the button.
  3. In step 1 of the SLO wizard, select the Service the SLO will be associated with.

  4. In step 2, select OpenTSDB as the Data Source for your SLO, then specify the Metric. You can choose either a Threshold Metric, where a single time series is evaluated against a threshold, or a Ratio Metric, which allows you to enter two time series to compare (for example, a count of good requests and total requests).

    note

    For the Ratio Metric, you can choose the Data Count Method:

    • For the Non-incremental method, we expect it to be the components of the sum.
    • For the Incremental method, we expect the value of a metric to be the current sum of some numerator.

    For more information, refer to the SLO Calculations Guide.

  5. Enter a Metric Selector or Metric selector for good counter and Metric selector for total counter for the metric you selected. The following are query examples:

    • Threshold metric for OpenTSDB:
      Metric Selector: m=none:{{.N9RESOLUTION}}-avg-zero:transaction.duration{host=host.01}

    • Ratio metric for OpenTSDB:
      Metric selector for good counter: m=none:{{.N9RESOLUTION}}-count-zero:cpu{cpu.usage=core.1}}}-count-zero:http.code{code=2xx}

      Metric selector for total counter: m=none:{{.N9RESOLUTION}}-count-zero:http.code{type=http.status_code}

  6. In step 3, define a Time Window for the SLO.

  7. In step 4, specify the Error Budget Calculation Method and your Objective(s).

  8. In step 5, add a Name, Description, and other details about your SLO. You can also select Alert Policies and Labels on this screen.

  9. When you’re done, click Create SLO.

Creating SLOs with OpenTSDB - YAML samples

Here’s an example of OpenTSDB using rawMetric (Threshold metric):

apiVersion: n9/v1alpha
kind: SLO
metadata:
name: opentsdb-slo-raw
displayName: OpenTSDB Raw
project: opentsdb
spec:
service: opentsdb-demo-service
indicator:
metricSource:
name: opentsdb
timeWindows:
- unit: Day
count: 1
calendar:
startTime: 2020-01-21T12:30:00.000Z
timeZone: America/New_York
budgetingMethod: Occurrences
objectives:
- displayName: Excellent
op: lte
rawMetric:
query:
opentsdb: >-
start="{{.BeginTime}}&end={{.EndTime}}&ms=true&m=none:{{.Resolution}}-avg-zero:transaction.duration{host=host.01}
value: 200
target: 0.8
- displayName: Good
op: lte
rawMetric:
query:
opentsdb: >-
start="{{.BeginTime}}&end={{.EndTime}}&ms=true&m=none:{{.Resolution}}-avg-zero:transaction.duration{host=host.01}
value: 250
target: 0.9
- displayName: Poor
op: lte
rawMetric:
query:
opentsdb: >-
start="{{.BeginTime}}&end={{.EndTime}}&ms=true&m=none:{{.Resolution}}-avg-zero:transaction.duration{host=host.01}
value: 300
target: 0.99

OpenTSDB Queries

Nobl9 Agent must have control over queried time range. The query must filter out documents in a specific time range:

start={{.BeginTime}}&end={{.EndTime}}}&m=none:{{.ResolutionTime}}-p75:test.to.test{tag.name_1=tag.tag_1}

  • p75 is the aggregation function that will be used (e.g., count, 99th percentile)

  • test.to.test is the target metric name

  • {tag.name_1=tag.tag_1} is an optional key-value set parameter for additional filtering (e.g., host=cluster01)

The following are the mandatory placeholders replaced by Nobl9 Agent with the correct time values.

  • {{.BeginTime}}

  • {{.EndTime}}

  • {{.Resolution}}

Nobl9 also supports a list of TSUIDs that share a common metric instead of a query. For more details, refer to TSUIDs and UIDs in the OpenTSDB documentation.

Querying the OpenTSDB Server

Nobl9 queries OpenTSDB API once per minute and requests a resolution of 4, thus giving 4 data points per minute. The start and end times, along with the specified query and resolution value are passed into the API call.

TSUIDs and UIDs | OpenTSDB 2.4 Documentation

Aggregation | OpenTSDB 2.4 Documentation

API query | OpenTSDB 2.4 Documentation

Downsampling | OpenTSDB 2.4 Documentation

Query filters | OpenTSDB 2.4 Documentation

Query Performance | OpenTSDB 2.4 Documentation

Agent Metrics | Nobl9 Documentation

Creating SLOs via Terraform | Nobl9 Terraform Documentation

Creating Agents via Terraform | Nobl9 Terraform Documentation