discovery.gce
discovery.gce
allows you to retrieve scrape targets from Google Compute Engine (GCE) instances.
The private IP address is used by default, but may be changed to the public IP address with relabeling.
Credentials are discovered by the Google Cloud SDK default client by looking in the following places, preferring the first location found:
- A JSON file specified by the
GOOGLE_APPLICATION_CREDENTIALS
environment variable. - A JSON file in the well-known path
$HOME/.config/gcloud/application_default_credentials.json
. - Fetched from the GCE metadata server.
If Alloy is running within GCE, the service account associated with the instance it’s running on should have at least read-only permissions to the compute resources. If running outside of GCE make sure to create an appropriate service account and place the credential file in one of the expected locations.
Usage
discovery.gce "<LABEL>" {
project = "<PROJECT_NAME>"
zone = "<ZONE_NAME>"
}
Arguments
You can use the following arguments with discovery.gce
:
For more information on the syntax of the filter
argument, refer to Google’s filter
documentation for Method: instances.list.
Blocks
The discovery.gce
component doesn’t support any blocks. You can configure this component with arguments.
Exported fields
The following fields are exported and can be referenced by other components:
Each target includes the following labels:
__meta_gce_instance_id
: The numeric ID of the instance.__meta_gce_instance_name
: The name of the instance.__meta_gce_interface_ipv4_NAME
: The IPv4 address of each named interface.__meta_gce_label_LABEL_NAME
: Each GCE label of the instance.__meta_gce_machine_type
: The full or partial URL of the machine type of the instance.__meta_gce_metadata_NAME
: Each metadata item of the instance.__meta_gce_network
: The network URL of the instance.__meta_gce_private_ip
: The private IP address of the instance.__meta_gce_project
: The GCP project in which the instance is running.__meta_gce_public_ip
: The public IP address of the instance, if present.__meta_gce_subnetwork
: The subnetwork URL of the instance.__meta_gce_tags
: A comma separated list of instance tags.__meta_gce_zone
: The GCE zone URL in which the instance is running.
Component health
discovery.gce
is only reported as unhealthy when given an invalid configuration.
In those cases, exported fields retain their last healthy values.
Debug information
discovery.gce
doesn’t expose any component-specific debug information.
Debug metrics
discovery.gce
doesn’t expose any component-specific debug metrics.
Example
Replace the following:
<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 theremote_write
API.<PASSWORD>
: The password to use for authentication to theremote_write
API.
Compatible components
discovery.gce
has exports that can be consumed by the following components:
- Components that consume Targets
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.