Coralogix

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

The Coralogix and Nobl9 integration leverages Coralogix's Prometheus metrics API to enable SLO management in Nobl9. By utilizing Coralogix's Prometheus-compatible metrics alongside Nobl9's SLOs, teams can effectively monitor application performance and service reliability through PromQL queries. The integration streamlines metrics monitoring workflows, enabling data-driven reliability decisions through Coralogix's metrics capabilities.

Coralogix parameters and supported features in Nobl9

General support:: Release channel: Stable; Connection method: Agent; Replay and SLI Analyzer: Historical data limit 30 days; Event logs: Not supported; Query checker: Not supported; Query parameters retrieval: Supported; Timestamp cache persistence: Supported
Query parameters:: Query interval: 1 min; Query delay: 0 sec; Jitter: 15 sec; Timeout: 30 sec
Agent details and minimum required versions for supported features:: Plugin name: n9prometheus; Query delay environment variable: CORALOGIX_QUERY_DELAY; Replay and SLI Analyzer: 0.65.0; Query parameters retrieval: 0.73.2; Timestamp cache persistence: 0.65.0
Additional notes:: Support for Prometheus metrics API; Learn more

Authorization

Agent deployment requires a Coralogix shared team API key. You can create such a key under your Coralogix account's Settings > Keys.

The generated team API key must have the DataQuerying role preset assigned.

Pass the created key as the CORALOGIX_API_KEY value when deploying your Coralogix agent.

Adding Coralogix as a data source

You can add Coralogix using the agent connection method only.

Nobl9 Web

Navigate to Integrations > Sources.
Click .
Click the required Source button.
Choose Agent.

Enter your required Coralogix Domain.
Set Step to define the metric resolution (mandatory, default: 60 seconds).
The Step value must be a positive integer. It controls how many data points Nobl9 retrieves in a single query.
- Aim for 15 seconds or more
- It should be equal to or less than your Coralogix query interval
Minimum agent version requirement
The Step parameter is supported starting from Nobl9 agent version 0.105.0-beta and later versions.

Select a Project (mandatory).
Project is a way to organize your Nobl9 resources and manage access to them.
When Project is skipped, Nobl9 uses the default project.
Enter a Display Name (optional).
Spaces are allowed.
Enter a Name (mandatory).
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.
Enter a Description (optional).
Provide extra details about it, its purpose, responsible persons, etc.
Up to 1050 characters.
Specify the Query delay to set a customized delay for queries when pulling the data from the data source.
- The default value in Coralogix integration for Query delay is 0 seconds.
Changing the query delay
Changing the query delay can affect your SLI data.
Learn more about query delay and its impact.
Enter a Maximum Period for Historical Data Retrieval.
- This value defines how far back in the past your data will be retrieved when replaying your SLO based on this data source.
- The maximum period value depends on the data source.
  Find the maximum value for your data source.
- A greater period can extend the loading time when creating an SLO.
Enter a Default Period for Historical Data Retrieval.
- It is used by SLOs connected to this data source.
- The value must be a positive integer or 0.
- By default, this value is set to 0. When you set it to >0, you will create SLOs with Replay.
Click Add Data Source.

YAML

YAML definition for the agent connection method
apiVersion: n9/v1alpha
kind: Agent
metadata:
  name: coralogix
  displayName: Coralogix Agent
  project: default
  annotations:
    area: latency
    env: prod
    region: us
    team: sales
spec:
  description: Example Coralogix Agent
  releaseChannel: stable
  coralogix:
    domain: coralogix.com
    step: 60
  historicalDataRetrieval:
    maxDuration:
      value: 30
      unit: Day
    defaultDuration:
      value: 15
      unit: Day
  queryDelay:
    value: 1
    unit: Second

Field	Type	Description
`queryDelay.unit` mandatory	enum	Specifies the unit for the query delay. Possible values: `Second` \| `Minute`. • Check query delay documentation for default unit of query delay for each source.
`queryDelay.value` mandatory	numeric	Specifies 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.
`releaseChannel` mandatory	enum	Specifies the release channel. Accepted values: `beta` \| `stable`.
Source-specific fields
`coralogix.domain` mandatory	string	A Coralogix domain you need to collect data from.
`coralogix.step` mandatory	integer	Defines metrics resolution in seconds. Must be a positive integer, 60 seconds by default. Recommendations: Use a value of at least 15 seconds and less than or equal to your Coralogix query interval.
Replay-related fields
`historicalDataRetrieval` optional	n/a	Optional structure related to configuration related to Replay. ❗ Use only with supported sources. • If omitted, Nobl9 uses the default values of `value: 0` and `unit: Day` for `maxDuration` and `defaultDuration`.
`maxDuration.value` optional	numeric	Specifies the maximum duration for historical data retrieval. Must be integer `≥ 0`. See Replay documentation for values of max duration per data source.
`maxDuration.unit` optional	enum	Specifies the unit for the maximum duration of historical data retrieval. Accepted values: `Minute` \| `Hour` \| `Day`.
`defaultDuration.value` optional	numeric	Specifies the default duration for historical data retrieval. Must be integer `≥ 0` and `≤` `maxDuration`.
`defaultDuration.unit` optional	enum	Specifies the unit for the default duration of historical data retrieval. Accepted values: `Minute` \| `Hour` \| `Day`.