Documentation Plugins Infinity data source Configure

Configure the Infinity data source

To configure the Infinity data source, you need to create an instance of the data source and optionally configure authentication, network settings, and other options.

This page explains how to:

• Add the data source
• Configure connection settings
• Configure authentication
• Configure network settings
• Configure additional settings
• Provision the data source

Before you begin

Before you configure the Infinity data source, you need:

• Grafana version 10.0 or later
• Organization admin permissions in Grafana, or equivalent RBAC permissions to manage data sources
• Network access from Grafana to your target API endpoints
• Appropriate credentials for authenticated endpoints (API keys, OAuth credentials, etc.)

Add the data source

To add the Infinity data source to Grafana:

1. In Grafana, navigate to Connections > Data sources.
2. Click Add new data source.
3. Search for Infinity.
4. Click the Infinity data source to configure it.
5. Enter a Name for the data source.
6. Configure the settings as described in the following sections.
7. Click Save & test to verify the connection.

The Infinity data source can work out of the box without any additional configuration. If you need the URL to be authenticated or pass additional headers/query/tls/timeout settings, configure the corresponding section.

Configuration options

The following sections describe the available configuration options for the Infinity data source.

Connection

For more information about URL configuration, refer to URL reference.

Authentication

The Infinity data source supports the following authentication methods:

• No authentication
• Basic authentication
• Bearer token
• API key
• Digest authentication
• OAuth passthrough
• OAuth 2.0 client credentials
• OAuth 2.0 JWT
• Azure authentication
• Azure Blob storage
• AWS authentication

No authentication

If your APIs don’t require any authentication, select the No Authentication method.

Basic authentication

Basic authentication sends a username and password with your request. In the request headers, the Authorization header uses the Basic <BASE64_ENCODED_USERNAME_AND_PASSWORD> format.

Bearer token

Bearer token authentication enables requests to authenticate using an access key, such as a JSON Web Token (JWT) or personal access token. In the request headers, the Authorization header uses the Bearer <API_KEY> format.

API key

With API key authentication, you can send a key-value pair to the API via request headers or query parameters.

Digest authentication

Digest authentication enables requests to authenticate using the RFC7616 HTTP Digest Access Authentication protocol.

OAuth passthrough

If your Grafana user is already authenticated via OAuth, this authentication method forwards the OAuth tokens to the API.

OAuth 2.0 client credentials

OAuth 2.0 client credentials authentication requires the following settings:

For advanced token customization, refer to OAuth2 Custom Tokens. Key customization options include:

• Custom header names (for example, X-API-Key instead of Authorization)
• Custom token value formats (for example, Token ${__oauth2.access_token} instead of Bearer ${__oauth2.access_token})
• Access to multiple token properties (access token, refresh token, token type)

OAuth 2.0 JWT

OAuth 2.0 JWT authentication requires the following settings:

OAuth 2.0 JWT authentication also supports token customization. Refer to OAuth2 Custom Tokens for details.

Azure authentication

To authenticate your API endpoints via Microsoft Azure authentication, refer to Azure authentication.

Azure Blob storage

To retrieve content from Azure Blob storage, configure the following settings:

AWS authentication

To authenticate your API endpoints via Amazon AWS authentication, refer to AWS authentication.

TLS settings

Configure TLS settings if your API requires client certificates or custom CA certificates.

HTTP headers

You can add custom HTTP headers to all requests made by the data source.

Query parameters

You can add query parameters that are sent with every request made by the data source. This works similarly to custom HTTP headers, but the parameters are appended to the URL as query strings.

Additional settings

Configure additional options for request handling and HTTP methods.

Timeout

Dangerous HTTP methods

By default, the Infinity data source only allows GET and POST HTTP methods to reduce the risk of destructive payloads. You can enable other methods such as PATCH, PUT, and DELETE for unconventional use cases.

Network settings

Configure how the Infinity data source connects to external APIs.

Proxy settings

You can configure proxy settings for routing requests through a proxy server.

Private data source connect (PDC)

Use private data source connect (PDC) to connect to and query data within a secure network without opening that network to inbound traffic from Grafana Cloud. Refer to Private data source connect for more information on how PDC works and Configure Grafana private data source connect (PDC) for steps on setting up a PDC connection.

If you use PDC with AWS Authentication, the PDC agent must allow internet egress to sts.<region>.amazonaws.com:443.

Health check

The settings for the Infinity data source on the configuration page don’t automatically validate the URL. To ensure that your settings, including authentication and API keys, are valid, you need to enable the custom health check in the Health check section of the configuration page.

If you receive a Health check failed message after you click Save & Test, check the URL to ensure it’s valid and you entered it correctly.

Provision the data source

You can define and configure the data source in YAML files as part of Grafana’s provisioning system. For more information about provisioning, and for available configuration options, refer to Provisioning Grafana.

Basic provisioning

YAML Copy

apiVersion: 1

datasources:
  - name: Infinity
    type: yesoreyeram-infinity-datasource

Provisioning with authentication

The following example shows provisioning with basic authentication:

YAML Copy

apiVersion: 1

datasources:
  - name: Infinity
    type: yesoreyeram-infinity-datasource
    basicAuth: true
    basicAuthUser: your_username
    jsonData:
      auth_method: basicAuth
      allowedHosts:
        - https://api.example.com
    secureJsonData:
      basicAuthPassword: your_password

Provisioning with custom headers

YAML Copy

apiVersion: 1

datasources:
  - name: Infinity
    type: yesoreyeram-infinity-datasource
    jsonData:
      httpHeaderName1: X-Custom-Header
      httpHeaderName2: X-API-Token
    secureJsonData:
      httpHeaderValue1: custom-value
      httpHeaderValue2: your-api-token

Advanced provisioning

The following example shows advanced provisioning with TLS and additional options:

YAML Copy

apiVersion: 1

datasources:
  - name: Infinity
    type: yesoreyeram-infinity-datasource
    basicAuth: true
    basicAuthUser: your_username
    jsonData:
      auth_method: basicAuth
      allowedHosts:
        - https://api.example.com
      oauthPassThru: false
      tlsSkipVerify: false
      tlsAuth: true
      tlsAuthWithCACert: true
      serverName: api.example.com
      timeoutInSeconds: 60
      allowDangerousHTTPMethods: false
    secureJsonData:
      basicAuthPassword: your_password
      tlsCACert: |
        -----BEGIN CERTIFICATE-----
        ...
        -----END CERTIFICATE-----
      tlsClientCert: |
        -----BEGIN CERTIFICATE-----
        ...
        -----END CERTIFICATE-----
      tlsClientKey: |
        -----BEGIN RSA PRIVATE KEY-----
        ...
        -----END RSA PRIVATE KEY-----

Provision the data source with Terraform

You can provision the Infinity data source using the Grafana Terraform provider. Use the grafana_data_source resource to create and manage data source instances.

Basic Terraform provisioning

hcl Copy

resource "grafana_data_source" "infinity" {
  type = "yesoreyeram-infinity-datasource"
  name = "Infinity"
}

Terraform provisioning with authentication

The following example shows provisioning with basic authentication:

hcl Copy

resource "grafana_data_source" "infinity" {
  type                = "yesoreyeram-infinity-datasource"
  name                = "Infinity"
  basic_auth_enabled  = true
  basic_auth_username = "your_username"

  json_data_encoded = jsonencode({
    auth_method  = "basicAuth"
    allowedHosts = ["https://api.example.com"]
  })

  secure_json_data_encoded = jsonencode({
    basicAuthPassword = "your_password"
  })
}

The following example shows provisioning with bearer token authentication:

hcl Copy

resource "grafana_data_source" "infinity" {
  type = "yesoreyeram-infinity-datasource"
  name = "Infinity"

  json_data_encoded = jsonencode({
    auth_method  = "bearerToken"
    allowedHosts = ["https://api.example.com"]
  })

  secure_json_data_encoded = jsonencode({
    bearerToken = "your_token"
  })
}

Terraform provisioning with custom headers

hcl Copy

resource "grafana_data_source" "infinity" {
  type = "yesoreyeram-infinity-datasource"
  name = "Infinity"

  json_data_encoded = jsonencode({
    httpHeaderName1 = "X-Custom-Header"
    httpHeaderName2 = "X-API-Token"
  })

  secure_json_data_encoded = jsonencode({
    httpHeaderValue1 = "custom-value"
    httpHeaderValue2 = "your-api-token"
  })
}

For more information about the Grafana Terraform provider, refer to the provider documentation.

Administrator configuration

Grafana administrators can configure plugin-wide settings using environment variables.

Pagination limits

By default, pagination queries are limited to 5 pages maximum. To increase this limit, set the GF_PLUGIN_PAGINATION_MAX_PAGES environment variable:

shell Copy

GF_PLUGIN_PAGINATION_MAX_PAGES=10

For Docker deployments:

shell Copy

docker run -p 3000:3000 \
  -e "GF_INSTALL_PLUGINS=yesoreyeram-infinity-datasource" \
  -e "GF_PLUGIN_PAGINATION_MAX_PAGES=10" \
  grafana/grafana:latest