Skip to main content


Reading time: 0 minute(s) (0 words)

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.


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

If want 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

To ensure data transmission between Nobl9 and your data source, it may be necessary to list Nobl9 IP addresses as trusted.

IP addresses to add to your allowlist:
Applies to only. In all other cases, contact Nobl9 support.

You can add the OpenTSDB data source using the agent connection method. Start with these steps:

  1. Navigate to Integrations > Sources.
  2. Click .
    The Data Source wizard opens.
  3. Select OpenTSDB.

OpenTSDB agent

Agent configuration in the UI

Follow the instructions below to configure your OpenTSDB agent:

  1. Select one of the following Release Channels:
    • The stable channel is fully tested by the Nobl9 team. It represents the final product; however, this channel does not contain all the new features of a beta release. Use it to avoid crashes and other limitations.
    • The beta channel is under active development. Here, you can check out new features and improvements without the risk of affecting any viable SLOs. Remember that features in this channel may be subject to change.
  2. 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, Nobl9 uses the default project.
  2. Enter a Display Name.
    You can enter a user-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-1). Nobl9 duplicates the display name here, transforming it into the supported format, 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. Specify the Query delay to set a customized delay for queries when pulling the data from the data source.
    • The default value in OpenTSDB integration for Query delay is 1 minute.
    Changing the Query delay may affect your SLI data. For more details, check the Query delay documentation.
  6. Click Add Data Source.

Agent using CLI - YAML

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

apiVersion: n9/v1alpha
kind: Agent
name: opentsdb
displayName: OpenTSDB agent
project: opentsdb
- Metrics
- Services
releaseChannel: beta
unit: Minute
value: 720
enumSpecifies the unit for the query delay. Possible values: Second | Minute.
• Check query delay documentation for default unit of query delay for each source.
numericSpecifies the value for the query delay.
• Must be a number less than 1440 minutes (24 hours).
• Check query delay documentation for default unit of query delay for each source.
enumSpecifies the release channel. Accepted values: beta | stable.
Source-specific fields
stringBase URL that points to your OpenTSDB instance.

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
name: nobl9-agent-nobl9-dev-opentsdb-opentsdb-test
namespace: default
type: Opaque
client_id: "unique_client_id"
client_secret: "unique_client_secret"
apiVersion: apps/v1
kind: Deployment
name: nobl9-agent-nobl9-dev-opentsdb-opentsdb-test
namespace: default
replicas: 1
nobl9-agent-name: opentsdb-test
nobl9-agent-project: opentsdb
nobl9-agent-organization: nobl9-dev
nobl9-agent-name: opentsdb-test
nobl9-agent-project: opentsdb
nobl9-agent-organization: nobl9-dev
- name: agent-container
image: nobl9/agent:0.69.4
memory: "350Mi"
cpu: "0.1"
- name: N9_CLIENT_ID
key: client_id
name: nobl9-agent-nobl9-dev-opentsdb-opentsdb-test
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.
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 .
  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).

    1. Choose the Data Count Method for your ratio metric:
      • Non-incremental: counts incoming metric values one-by-one. So the resulting SLO graph is pike-shaped.
      • Incremental: counts the incoming metric values incrementally, adding every next value to previous values. It results in a constantly increasing SLO graph.
  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}

    SLI values for good and total
    When choosing the query for the ratio SLI (countMetrics), keep in mind that the values ​​resulting from that query for both good and total:
    • Must be positive.
    • While we recommend using integers, fractions are also acceptable.
      • If using fractions, we recommend them to be larger than 1e-4 = 0.0001.
    • Shouldn't be larger than 1e+20.
  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
name: opentsdb-slo-raw
displayName: OpenTSDB Raw
project: opentsdb
service: opentsdb-demo-service
name: opentsdb
- unit: Day
count: 1
startTime: 2020-01-21T12:30:00.000Z
timeZone: America/New_York
budgetingMethod: Occurrences
- displayName: Excellent
op: lte
opentsdb: >-
value: 200
target: 0.8
- displayName: Good
op: lte
opentsdb: >-
value: 250
target: 0.9
- displayName: Poor
op: lte
opentsdb: >-
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:


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

  • 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

Creating SLOs via Terraform

Creating agents via Terraform