databricksreceiver

README

Databricks Receiver (Alpha)

The Databricks Receiver uses the Databricks API to generate metrics about the operation of a Databricks instance.

Supported pipeline types: metrics

🚧 This receiver is in ALPHA. Behavior, configuration fields, and metric data model are subject to change.

Configuration

The following fields are required:

• instance_name: A string representing the name of the instance. This value gets set as a databricks.instance.name resource attribute.
• endpoint: The protocol (http or https), hostname, and port for the Databricks API, without a trailing slash.
• token: An access token to authenticate to the Databricks API.

The following fields are optional:

• collection_interval: How often this receiver fetches information from the Databricks API. Must be a string readable by time.ParseDuration. Defaults to 30s.
• max_results: The maximum number of items to return per API call. Defaults to 25 which is the maximum value. If set explicitly, the API requires a value greater than 0 and less than or equal to 25.

Example

receivers:
  databricks:
    instance_name: my-instance
    endpoint: https://my.host
    token: abc123
    collection_interval: 60s
    max_results: 10

Documentation

Index

• func NewFactory() component.ReceiverFactory
• type Config

Functions

func NewFactory

func NewFactory() component.ReceiverFactory

Types

type Config

type Config struct {
	confighttp.HTTPClientSettings           `mapstructure:",squash"`
	InstanceName                            string `mapstructure:"instance_name"`
	Token                                   string
	scraperhelper.ScraperControllerSettings `mapstructure:",squash"`
	MaxResults                              int `mapstructure:"max_results"`
}