Menu
Open source

discovery.triton

discovery.triton discovers Triton Container Monitors and exposes them as targets.

Usage

alloy
discovery.triton "LABEL" {
	account    = ACCOUNT
	dns_suffix = DNS_SUFFIX
	endpoint   = ENDPOINT
}

Arguments

The following arguments are supported:

NameTypeDescriptionDefaultRequired
accountstringThe account to use for discovering new targets.yes
rolestringThe type of targets to discover."container"no
dns_suffixstringThe DNS suffix that is applied to the target.yes
endpointstringThe Triton discovery endpoint.yes
groupslist(string)A list of groups to retrieve targets from.no
portintThe port to use for discovery and metrics scraping.9163no
refresh_intervaldurationThe refresh interval for the list of targets.60sno
versionintThe Triton discovery API version.1no

role can be set to:

  • "container" to discover virtual machines (SmartOS zones, lx/KVM/bhyve branded zones) running on Triton
  • "cn" to discover compute nodes (servers/global zones) making up the Triton infrastructure

groups is only supported when role is set to "container". If omitted all containers owned by the requesting account are scraped.

Blocks

The following blocks are supported inside the definition of discovery.triton:

HierarchyBlockDescriptionRequired
tls_configtls_configTLS configuration for requests to the Triton API.no

tls_config block

NameTypeDescriptionDefaultRequired
ca_pemstringCA PEM-encoded text to validate the server with.no
ca_filestringCA certificate to validate the server with.no
cert_pemstringCertificate PEM-encoded text for client authentication.no
cert_filestringCertificate file for client authentication.no
insecure_skip_verifyboolDisables validation of the server certificate.no
key_filestringKey file for client authentication.no
key_pemsecretKey PEM-encoded text for client authentication.no
min_versionstringMinimum acceptable TLS version.no
server_namestringServerName extension to indicate the name of the server.no

The following pairs of arguments are mutually exclusive and can’t both be set simultaneously:

  • ca_pem and ca_file
  • cert_pem and cert_file
  • key_pem and key_file

When configuring client authentication, both the client certificate (using cert_pem or cert_file) and the client key (using key_pem or key_file) must be provided.

When min_version is not provided, the minimum acceptable TLS version is inherited from Go’s default minimum version, TLS 1.2. If min_version is provided, it must be set to one of the following strings:

  • "TLS10" (TLS 1.0)
  • "TLS11" (TLS 1.1)
  • "TLS12" (TLS 1.2)
  • "TLS13" (TLS 1.3)

Exported fields

The following fields are exported and can be referenced by other components:

NameTypeDescription
targetslist(map(string))The set of targets discovered from the Triton API.

When role is set to "container", each target includes the following labels:

  • __meta_triton_groups: The list of groups belonging to the target joined by a comma separator.
  • __meta_triton_machine_alias: The alias of the target container.
  • __meta_triton_machine_brand: The brand of the target container.
  • __meta_triton_machine_id: The UUID of the target container.
  • __meta_triton_machine_image: The target container’s image type.
  • __meta_triton_server_id: The server UUID the target container is running on.

When role is set to "cn" each target includes the following labels:

  • __meta_triton_machine_alias: The hostname of the target (requires triton-cmon 1.7.0 or newer).
  • __meta_triton_machine_id: The UUID of the target.

Component health

discovery.triton is only reported as unhealthy when given an invalid configuration. In those cases, exported fields retain their last healthy values.

Debug information

discovery.triton does not expose any component-specific debug information.

Debug metrics

discovery.triton does not expose any component-specific debug metrics.

Example

alloy
discovery.triton "example" {
	account    = TRITON_ACCOUNT
	dns_suffix = TRITON_DNS_SUFFIX
	endpoint   = TRITON_ENDPOINT
}

prometheus.scrape "demo" {
	targets    = discovery.triton.example.targets
	forward_to = [prometheus.remote_write.demo.receiver]
}

prometheus.remote_write "demo" {
	endpoint {
		url = PROMETHEUS_REMOTE_WRITE_URL

		basic_auth {
			username = USERNAME
			password = PASSWORD
		}
	}
}

Replace the following:

  • TRITON_ACCOUNT: Your Triton account.
  • TRITON_DNS_SUFFIX: Your Triton DNS suffix.
  • TRITON_ENDPOINT: Your Triton endpoint.
  • PROMETHEUS_REMOTE_WRITE_URL: The URL of the Prometheus remote_write-compatible server to send metrics to.
  • USERNAME: The username to use for authentication to the remote_write API.
  • PASSWORD: The password to use for authentication to the remote_write API.

Compatible components

discovery.triton has exports that can be consumed by the following components:

Note

Connecting some components may not be sensible or components may require further configuration to make the connection work correctly. Refer to the linked documentation for more details.