AMS Prometheus

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

Amazon Managed Service for Prometheus (or AMS Prometheus) is a monitoring and alerting service that ensures easy-to-use monitoring of containerized applications and infrastructure. It's scalable, and you don't have to worry about hosting it yourself.

Amazon Prometheus 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: Supported; Timestamp cache persistence: Supported
Query parameters:: Query interval: 1 min; Query delay: 0; Jitter: 15 sec; Timeout: 30 sec
Agent details and minimum required versions for supported features:: Plugin name: n9prometheus; Query delay environment variable: PROM_QUERY_DELAY; Replay and SLI Analyzer: 0.65.0; Query parameters retrieval: 0.73.2; Timestamp cache persistence: 0.65.0; Custom HTTP headers: 0.83.0-beta
Additional notes:: Support for Prometheus metrics; No support for IAM roles for bare EC2 instances; Learn more

Authentication

For more details, refer to Authentication for AMS Prometheus.

To set up the connection, AMS Prometheus requires users to enter the URL. To get the URL:

Sign in to your AWS account.
Click the AMS Prometheus in the Management & Governance panel:

Image 1: Configuring authentication for AMS Prometheus (1)
Click All workspaces.

Image 2: Configuring authentication for AMS Prometheus (2)
Choose a relevant workspace:

Image 3: Configuring authentication for AMS Prometheus (3)
In the Summary screen, copy the Endpoint - query URL

Image 4: Configuring authentication for AMS Prometheus (4)

warning

The url that you need is the Endpoint - query URL without the /api/v1/query string at the end of the URL.

Adding Amazon Managed Service for Prometheus as a data source

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

💻ip allowlist

IP addresses to include in your allowlist for secure access:

If you're using app.nobl9.com instance:

18.159.114.21
18.158.132.186
3.64.154.26

If you're using us1.nobl9.com instance:

34.121.54.120
34.123.193.191
34.134.71.10
35.192.105.150
35.225.248.37
35.226.78.175
104.198.44.161

You can add the AMS Prometheus data source using the agent connection method.

Nobl9 Web

Follow the instructions below to create your AMS Prometheus agent connection:

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.
Add the URL to connect to your data source (mandatory).
Refer to Authentication for AMS Prometheus for detailed instructions on how to get the URL.
Enter a Region (mandatory).
The list of supported Regions for AMS Prometheus is here.

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 AMS Prometheus integration for Query delay is 0 seconds.
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.

💡Custom HTTP headers

When you need to set custom HTTP headers in your Nobl9 agent, include them in your agent deployment.

sloctl

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

YAML definition for the agent connection method
apiVersion: n9/v1alpha
kind: Agent
metadata:
  name: amazon-prometheus
  displayName: Amazon Prometheus Agent
  project: default
spec:
  description: Example Amazon Prometheus Agent
  releaseChannel: stable
  amazonPrometheus:
    url: https://aps-workspaces.us-east-1.amazonaws.com/workspaces/ws-f49ecf99-6dfa-4b00-9f94-a50b10a3010b
    region: us-east-1
  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
`amazonPrometheus.url` mandatory	string	is the `Endpoint - query URL` in AMS Prometheus. Check Authentication for AMS Prometheus for detailed instructions on how to get it
`amazonPrometheus.region` mandatory	string	Check the list of supported regions for AMS Prometheus.
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`.