telemetries

Creates, updates, deletes, gets or lists a telemetries resource.

Overview

Name	telemetries
Type	Resource
Id	nvidia.nvcf_deployments.telemetries

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
name	string (UTF-8)	Telemetry name
telemetry_id	string (uuid)	Unique telemetry ID (wire: telemetryId)
created_at	string (date_time)	Telemetry creation timestamp (wire: createdAt)
endpoint	string (UTF-8)	URL for the telemetry endpoint
protocol	string (UTF-8)	Protocol used for communication (HTTP, GRPC)
provider	string (UTF-8)	Telemetry provider (PROMETHEUS, GRAFANA_CLOUD, SPLUNK, DATADOG, SERVICENOW, KRATOS, KRATOS_THANOS, TIMESTREAM, VICTORIAMETRICS, AZURE_MONITOR, OTEL_COLLECTOR)
types	array	Set of telemetry data types

list

Name	Datatype	Description
name	string (UTF-8)	Telemetry name
telemetry_id	string (uuid)	Unique telemetry ID (wire: telemetryId)
created_at	string (date_time)	Telemetry creation timestamp (wire: createdAt)
endpoint	string (UTF-8)	URL for the telemetry endpoint
protocol	string (UTF-8)	Protocol used for communication (HTTP, GRPC)
provider	string (UTF-8)	Telemetry provider (PROMETHEUS, GRAFANA_CLOUD, SPLUNK, DATADOG, SERVICENOW, KRATOS, KRATOS_THANOS, TIMESTREAM, VICTORIAMETRICS, AZURE_MONITOR, OTEL_COLLECTOR)
types	array	Set of telemetry data types

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	telemetry_id		Retrieves the details of a specific telemetry configuration by its ID. requires a bearer token with 'manage_telemetries' scope in the HTTP Authorization header.
list	select			Retrieves telemetry configurations for a specific NVIDIA Cloud Account. requires a bearer token with 'manage_telemetries' scope in the HTTP Authorization header.
create	insert	endpoint, protocol, provider, secret, types		Creates telemetry endpoints for NVIDIA Cloud Accounts. requires a bearer token with 'manage_telemetries' scope in the HTTP Authorization header.
delete	delete	telemetry_id		Deletes a specific telemetry configuration for a NVIDIA Cloud Account. requires a bearer token with 'manage_telemetries' scope in the HTTP Authorization header. If there any functions that are dependent on the Telemetry that is being deleted, then response with 400 status code will be returned.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
telemetry_id	string (uuid)

SELECT examples

get

Retrieves the details of a specific telemetry configuration by its ID. requires a bearer token with 'manage_telemetries' scope in the HTTP Authorization header.

SELECT
name,
telemetry_id,
created_at,
endpoint,
protocol,
provider,
types
FROM nvidia.nvcf_deployments.telemetries
WHERE telemetry_id = '{{ telemetry_id }}' -- required
;

list

Retrieves telemetry configurations for a specific NVIDIA Cloud Account. requires a bearer token with 'manage_telemetries' scope in the HTTP Authorization header.

SELECT
name,
telemetry_id,
created_at,
endpoint,
protocol,
provider,
types
FROM nvidia.nvcf_deployments.telemetries
;

INSERT examples

create

Creates telemetry endpoints for NVIDIA Cloud Accounts. requires a bearer token with 'manage_telemetries' scope in the HTTP Authorization header.

INSERT INTO nvidia.nvcf_deployments.telemetries (
endpoint,
protocol,
provider,
secret,
types
)
SELECT 
'{{ endpoint }}' /* required */,
'{{ protocol }}' /* required */,
'{{ provider }}' /* required */,
'{{ secret }}' /* required */,
'{{ types }}' /* required */
RETURNING
telemetry
;

Manifest

# Description fields are for documentation purposes
- name: telemetries
props:
  - name: endpoint
    value: "{{ endpoint }}"
    description: |
      Telemetry endpoint URL
  - name: protocol
    value: "{{ protocol }}"
    description: |
      Protocol used for communication
    valid_values: ['HTTP', 'GRPC']
  - name: provider
    value: "{{ provider }}"
    description: |
      Telemetry provider
    valid_values: ['PROMETHEUS', 'GRAFANA_CLOUD', 'SPLUNK', 'DATADOG', 'SERVICENOW', 'KRATOS', 'KRATOS_THANOS', 'TIMESTREAM', 'VICTORIAMETRICS', 'AZURE_MONITOR', 'OTEL_COLLECTOR']
  - name: secret
    description: |
      Single secret associated with the telemetry configuration
    value:
      name: "{{ name }}"
      value: "{{ value }}"
  - name: types
    value:
      - "{{ types }}"
    description: |
      Set of telemetry data types

DELETE examples

delete

Deletes a specific telemetry configuration for a NVIDIA Cloud Account. requires a bearer token with 'manage_telemetries' scope in the HTTP Authorization header. If there any functions that are dependent on the Telemetry that is being deleted, then response with 400 status code will be returned.

DELETE FROM nvidia.nvcf_deployments.telemetries
WHERE telemetry_id = '{{ telemetry_id }}' --required
;