Graphite

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

Graphite is a monitoring tool used to track the performance of websites, applications, business services, and networked servers.

Graphite parameters and supported features in Nobl9

General support:: Release channel: Stable, Beta; Connection method: Agent; Replay and SLI Analyzer: Historical data limit 30 days; Event logs: Not supported; Query checker: Not supported; Query parameters retrieval: Not supported; Timestamp cache persistence: Not 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: n9graphite; Query delay environment variable: GRAPHITE_QUERY_DELAY; Replay and SLI Analyzer: 0.65.0

Authentication

Graphite does not directly support authentication for connections to its HTTP API. Organizations can set it in their infrastructure. Nobl9 connects to Graphite through the Render URL API. To connect Nobl9 agent to Graphite, you must specify your Render URL API endpoint that allows you to generate graphs and retrieve raw data from Graphite. For more details, see The Render URL API | Graphite documentation.

Optional Bearer token

If GRAPHITE_AUTH_BEARER_TOKEN variable is set during agent startup, its value will be added as an Authorization header to every HTTP request.

Optional HTTP basic authentication credentials

This plugin allows credentials passed as environment variables during agent startup. The keys are GRAPHITE_BASIC_AUTH_USERNAME and GRAPHITE_BASIC_AUTH_PASSWORD.

Adding Graphite as a data source

You can add the Graphite data source using the agent connection method.

Nobl9 Web

Follow the instructions below to configure your Graphite agent:

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

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 can change.
Enter the Render URL API to connect to your data source.
The URL must start with http:// or https://.

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.
Enter a Display Name.
You can enter a user-friendly name with spaces in this field.
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.
Enter a Description.
Here you can add details such as who is responsible for the integration (team/owner) and the purpose of creating it.
Specify the Query delay to set a customized delay for queries when pulling the data from the data source.
- The default value in Graphite integration for Query delay is 1 minute.
info
Changing the Query delay may affect your SLI data. For more details, check the Query delay documentation.
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.

Deploy your agent in a Kubernetes cluster or Docker container.

caution

Since Graphite is based on user settings, make sure Replay is aligned with the settings applied in the storage-schemas.conf and storage-aggregation.conf configuration files.

sloctl

Create a YAML definition to set up an agent connection with Graphite. For this, refer to the following example:

YAML definition for the agent connection method
apiVersion: n9/v1alpha
kind: Agent
metadata:
  name: graphite
  displayName: Graphite Agent
  project: default
spec:
  description: Example Graphite Agent
  releaseChannel: stable
  graphite:
    url: http://graphite.graphite:8080/render
  historicalDataRetrieval:
    maxDuration:
      value: 30
      unit: Day
    defaultDuration:
      value: 15
      unit: Day
  queryDelay:
    value: 2
    unit: Minute

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
`graphiteURL` mandatory	string	Render API URL endpoint of Graphite's instance. See authentication for more details.
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`.