Skip to main content

Instana

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

Instana is an observability platform that delivers automated Application Performance Monitoring (APM), used for website, infrastructure, and application monitoring.

Instana parameters and supported features in Nobl9
General support:
Release channel: Stable, Beta
Connection method: Agent, Direct
Replay and SLI Analyzer: Not supported
Event logs: Supported
Query checker: Not supported
Query parameters retrieval: Not supported
Timestamp cache persistence: Supported

Query parameters:
Query interval: 1 min
Query delay: 1 min
Jitter: 15 sec
Timeout: 30 sec

Agent details and minimum required versions for supported features:
Plugin name: n9instana
Query delay environment variable: INSTANA_QUERY_DELAY
Timestamp cache persistence: 0.65.0

Additional notes:
No support for website and application (ratio) monitoring metrics
Learn more Opens in a new tab

Creating SLOs with Instana​

You can create Instana SLOs based on the following:

  • Infrastructure
    • Use it for infrastructure components
    • Threshold and ratio metric types are supported
  • Application
    • Use it for defined applications, discovered services, and endpoints
    • Only the threshold metric type is supported

Nobl9 Web​

  1. Navigate to Service Level Objectives.
  2. Click .
  3. Select a Service.
    It will be the location for your SLO in Nobl9.
  4. Select your Instana data source.
  5. Metric refers to the way of calculating and interpreting calculate and interpret data from your data source.
    • Threshold metric is defined by a single numerical value (the threshold) that separates satisfactory performance from unsatisfactory performance. It's represented by a single time series evaluated against the threshold.
    • Ratio metric expresses the performance as a fraction or proportion, typically by dividing the number of successful events by the total number of potential events (successes + failures). It's represented by two-time series for comparison for good events and total events.
      For ratio metrics, select the Data count method.

      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.
  1. Plugin ID is the ID of the plugin available in your monitored system for which you want to retrieve the metric.
  2. Metric ID is the ID of the metric you want to retrieve.
  3. Select the Metric Retrieval Method:
    • Query uses dynamic focus queries
      For example, entity.selfType:zookeeper AND entity.label:replica.1.
    • Snapshot ID is a unique, point-in-time record of your monitored Instana component's state and configuration
  1. Define the Time window for your SLO:
  2. Configure the Error budget calculation method and Objectives:
    • Occurrences method counts good attempts against the count of total attempts.
    • Time Slices method measures how many good minutes were achieved (when a system operates within defined boundaries) during a time window.
    • You can define up to 12 objectives for an SLO.

    • Similar threshold values for objectives
      To use similar threshold values for different objectives in your SLO, we recommend differentiating them by setting varying decimal points for each objective.
      For example, if you want to use threshold value 1 for two objectives, set it to 1.0000001 for the first objective and to 1.0000002 for the second one.
  3. Add the Display name, Name, and other settings for your SLO:
    • Name identifies your SLO in Nobl9. After you save the SLO, its name becomes read-only.
      Use only lowercase letters, numbers, and dashes.
    • Select No data anomaly alert to receive notifications when your SLO stops reporting data for a specified period:
      • Choose up to five supported Alert methods.
      • Specify the delay period before Nobl9 sends an alert about the missing data.
        From 5 minutes to 31 days. Default: 15 minutes
    • Add alert policies, labels, and links, if required.
      Limits per SLO: 20 alert policies or links, 30 labels.
  4. Click CREATE SLO.

  5. SLO configuration use case
    Check the SLO configuration use case for a real-life SLO example.

YAML​

Generic schema with a description of objects and field validations:

apiVersion: n9/v1alpha
kind: SLO
metadata:
name: string
displayName: string # optional
project: string
spec:
description: string # optional
service: [service name] # name of the service you defined in the same project as the SLO
indicator:
metricSource:
name: [datasource name] # name of the data source you defined
project: [project name] # optional if not defined, project is the same as the SLO
rawMetric:
# exactly one of possible source types which depends on selected metricSource for the SLO
instana: # application XOR infrastructure
metricType: oneOf{"application", "infrastructure"} # mandatory
infrastructure:
metricRetrievalMethod: oneOf{"query", "snapshot"} # mandatory
query: "string" # XOR with snapshotId
snapshotId: "string" # XOR with query
metricId: "string" # mandatory
pluginId: "string" # mandatory
application:
metricId: # mandatory, oneOf{"calls", "erroneousCalls", "errors", "latency"}
aggregation: "" # mandatory, value depends on the metricId type. See notes below
groupBy: # mandatory
tag: "" # mandatory
tagEntity: "" # mandatory, oneOf{"DESTINATION", "SOURCE", "NOT_APPLICABLE"}
tagSecondLevelKey: "" # mandatory
apiQuery: "{}" # mandatory, API query user passes in a JSON format. Must be a valid JSON
includeInternal: false # optional, default value is false
includeSynthetic: false # optional, default value is false
Click to open field reference
FieldTypeDescription
apiVersion
mandatory
stringAPI version. Use n9/v1alpha
kind
mandatory
stringThe resource type. Use SLO
Metadata
metadata.name
mandatory
stringName identifier for the SLO. Use only lowercase alphanumeric characters
metadata.displayNamestringUser-friendly SLO name
metadata.project
mandatory
stringThe name identifier of the project where you need to host your SLO
metadata.labelsobject (map: string[])Grouping labels for filtering or viewing
metadata.annotationsobject (map: string)Flat string annotations
Spec
spec.descriptionstringSLO description
spec.indicator.metricSource.name
mandatory
stringData source name
spec.indicator.metricSource.project
mandatory
stringProject containing the data source
spec.indicator.metricSource.kind
mandatory
stringData source connection method. Can be Agent or Direct
spec.budgetingMethod
mandatory
enumError budget calculation method. Can be Occurrences or Time slices
spec.objectives
mandatory
arrayYour SLO objective definition, up to 12 objectives per SLO.
spec.objectives[].displayNamestringUser-friendly objective name
spec.objectives[].value
mandatory
numberData point values that is considered "good" (e.g., 200.0).
In SLOs with two or more objectives, keep each objective's value unique.
In ratio (count) metrics, value is retained for legacy purposes.
spec.objectives[].name
mandatory
stringName identifier for this objective
spec.objectives[].op
mandatory
string (enum)Operator for objective. One of:
lte (less than or equal to)
lt (less than)
gte (greater than or equal to)
gt (greater than)
spec.objectives[].target
mandatory
floatThe percentage of the good minutes or occurrences that must meet the desired performance (e.g., is the target is 0.95, the good performance is expected to be observed in at least 95% of the time window)
spec.objectives[].rawMetric/.countMetric
mandatory
objectThe metric type indicator. Set:
rawMetric for a threshold metric
countMetric for a ratio metric.
A ratio metric requires the additional fields:
countMetric.incremental (boolean) the data count method
countMetric.good/.bad and countMetric.total a numerator and denominator queries
spec.objectives[].countMetric.incremental
mandatory
booleanThe data count method for a ratio (countMetric) metric type
spec.objectives[].primarybooleanThe indicator of a primary SLO objective
spec.service
mandatory
stringThe name identifier of a service to host this SLO. The service must exist in the project specified in metadata.project
spec.timeWindows
mandatory
arrayDefines SLO time window for error budget calculation. Set:
isRolling: true for the rolling time window type
isRolling: false for the calendar-aligned type
spec.timeWindows.unit
mandatory
integerThe time window units. One of:
Day | Hour | Minute for the rolling time window
Year | Quarter | Month | Week | Day for the calendar-aligned time window
spec.timeWindows.count
mandatory
integerThe number of units in a time window
spec.timeWindows.startTimestringMandatory for calendar-aligned time windows. Date and time in the format YYYY-MM-DDTHH:mm:ss
spec.timeWindows.timeZonestringMandatory for calendar-aligned time-windows. A valid IANA Time Zone Database name
spec.timeWindows.isRolling
mandatory
boolean
true for the rolling time window type
false for the calendar-aligned type
spec.alertPoliciesarrayThe name identifiers of alert policies to be linked to this SLO (must be from the same project as the SLO). Up to 20 alert policies per SLO.
spec.attachmentsarrayLinks to any additional attributes of this SLO
spec.anomalyConfigobjectSettings for a manual no data anomaly detection rule
spec.noData.alertMethodsarrayList of alert methods for no-data anomaly. Up to five alert methods per SLO. Every alert method must have the name and project fields
spec.noData.alertAfterstringWaiting time before sending a no-data notification. Must be 5m to 31d.
Default: 15m
Source-specific fields
instana.infrastructure
mandatory
objectDefines the infrastructure metric. XOR with instana.application
instana.infrastructure.metricRetrievalMethod
mandatory
stringOne of: query (string) | snapshot (string)
instana.infrastructure.metricId
mandatory
stringYour Instana metric identifier
instana.infrastructure.pluginId
mandatory
stringYour Instana plugin identifier
instana.application
mandatory
objectDefines the application metric (threshold only). XOR with instana.infrastructure
instana.application.metricId
mandatory
stringYour Instana metric identifier. One of: calls | erroneousCalls | | errors | latency
instana.application.aggregation
mandatory
stringData aggregation method. One of:
β€’ sum if metricId: calls, metricId: erroneousCalls, or metricId: latency
β€’ mean if metricId: errors or metricId: latency
β€’ min | max | p25 | p75 | p90 | p95 | p98 | p99 if metricId: latency
instana.application.groupBy
mandatory
objectMirrors the Instana grouping filter. Matches:
β€’tagβ€”groupbyTag
β€’ tagEntityβ€”groupbyTagEntity one of: DESTINATION | SOURCE | NOT_APPLICABLE
β€’tagSecondLevelKeyβ€”groupbyTagSecondLevelKey
instana.application.apiQuery
mandatory
stringA valid JSON query
instana.application.includeInternal
optional
booleanInclude Internal Hidden Calls. Default false
instana.application.includeSynthetic
optional
booleanInclude Synthetic Hidden Calls. Default false

Threshold (rawMetric)​

Sample Instana threshold SLO with the metricType: application
apiVersion: n9/v1alpha
kind: SLO
metadata:
name: api-server-slo
displayName: API Server SLO
project: default
labels:
area:
- latency
- slow-check
env:
- prod
- dev
region:
- us
- eu
team:
- green
- sales
annotations:
area: latency
env: prod
region: us
team: sales
spec:
description: Example Instana SLO
indicator:
metricSource:
name: instana
project: default
kind: Agent
budgetingMethod: Occurrences
objectives:
- displayName: Good response (200)
value: 200
name: ok
target: 0.95
rawMetric:
query:
instana:
metricType: application
application:
metricId: calls
aggregation: sum
groupBy:
tag: application.name
tagEntity: DESTINATION
apiQuery: |
{
"type": "EXPRESSION",
"logicalOperator": "AND",
"elements": [
{
"type": "TAG_FILTER",
"name": "kubernetes.cluster.name",
"operator": "EQUALS",
"entity": "DESTINATION",
"value": "n9-dev-tooling-cluster"
},
{
"type": "TAG_FILTER",
"name": "kubernetes.container.name",
"operator": "EQUALS",
"entity": "DESTINATION",
"value": "data-node"
},
{
"type": "TAG_FILTER",
"name": "call.type",
"operator": "EQUALS",
"entity": "NOT_APPLICABLE",
"value": "HTTP"
},
{
"type": "TAG_FILTER",
"name": "endpoint.name",
"operator": "EQUALS",
"entity": "DESTINATION",
"value": "GET /"
}
]
}
op: lte
primary: true
service: api-server
timeWindows:
- unit: Month
count: 1
isRolling: false
calendar:
startTime: '2022-12-01 00:00:00'
timeZone: UTC
alertPolicies:
- fast-burn-5x-for-last-10m
attachments:
- url: https://docs.nobl9.com
displayName: Nobl9 Documentation
anomalyConfig:
noData:
alertMethods:
- name: slack-notification
project: default
alertAfter: 1h

Ratio (countMetric)​

Sample Instana threshold SLO with the metricType: infrastructure with the query retrieval method
apiVersion: n9/v1alpha
kind: SLO
metadata:
name: api-server-slo
displayName: API Server SLO
project: default
labels:
area:
- latency
- slow-check
env:
- prod
- dev
region:
- us
- eu
team:
- green
- sales
annotations:
area: latency
env: prod
region: us
team: sales
spec:
description: Example Instana SLO
indicator:
metricSource:
name: instana
project: default
kind: Agent
budgetingMethod: Occurrences
objectives:
- displayName: Good response (200)
value: 1
name: ok
target: 0.95
countMetrics:
incremental: true
good:
instana:
metricType: infrastructure
infrastructure:
metricRetrievalMethod: query
query: entity.selfType:zookeeper AND entity.label:replica.1
metricId: error_requests_count
pluginId: zooKeeper
total:
instana:
metricType: infrastructure
infrastructure:
metricRetrievalMethod: query
query: entity.selfType:zookeeper AND entity.label:replica.1
metricId: total_requests_count
pluginId: zooKeeper
primary: true
service: api-server
timeWindows:
- unit: Month
count: 1
isRolling: false
calendar:
startTime: '2022-12-01 00:00:00'
timeZone: UTC
alertPolicies:
- fast-burn-5x-for-last-10m
attachments:
- url: https://docs.nobl9.com
displayName: Nobl9 Documentation
anomalyConfig:
noData:
alertMethods:
- name: slack-notification
project: default
alertAfter: 1h

Infrastructure metric components​

This section explains the key components needed for Infrastructure Instana metric configuration.

Plugin ID​

Purpose: Identifies the entity type for metric collection.

To retrieve the list of available plugins, send the following API request:

GET the list of available Instana plugins
curl --request GET \
--url https://${BASE_URL}/api/infrastructure-monitoring/catalog/plugins \
--header "authorization: apiToken ${API_TOKEN}"

The response includes:

  • pluginβ€”the Plugin ID value to use
  • labelβ€”the display name shown in UI

Metric ID​

Purpose: Specifies which metric to retrieve.

To get available metrics for your plugin, send the following API request:

GET available metrics for a plugin
curl --request GET \
--url https://${BASE_URL}/api/infrastructure-monitoring/catalog/metrics/${PLUGIN_ID} \
--header "authorization: apiToken ${API_TOKEN}"

The response includes metricIdβ€”use its value in your metric.

Single metric limitation

Nobl9 supports retrieving one metric at a time.

Query​

Purpose: Defines which data to collect using Instana's Dynamic Focus. Required for Metric retrieval method > Query.

Dynamic Focus queries use the Lucene query syntax.

Construct the query in the Infrastructure > Map Instana section and copy it. For example, entity.selfType:zookeeper AND entity.label:replica.1.

No aggregation support

Instana does not support infrastructure metric aggregation. Ensure your query targets specific entities (e.g., cluster, zone, or node).

Snapshot ID​

Purpose: References an entity state at a specific time. Required for Metric retrieval method > Snapshot ID.

You can find a snapshot ID in the Instana UI URL: snapshotId=${SNAPSHOT_ID}.

Snapshot changes

Configuration updates (like changing the metadata) may result in changing the snapshot ID. Update your SLO with the new Snapshot ID to maintain data collection.

Querying the Instana server​

Nobl9 queries the Instana server on a per-minute basis. This allows Nobl9 to collect up to one data point per minute.

Instana API rate limits​

When accessing the Instana API, consider the following limitations:

  • Maximum of 5000 API calls per hour
Check out these related guides and references: