environments_trace_config
Creates, updates, deletes, gets or lists an environments_trace_config resource.
Overview
| Name | environments_trace_config |
| Type | Resource |
| Id | google.apigee.environments_trace_config |
Fields
The following fields are returned by SELECT queries:
- organizations_environments_get_trace_config
Successful response
| Name | Datatype | Description |
|---|---|---|
endpoint | string | Required. Endpoint of the exporter. |
exporter | string | Required. Exporter that is used to view the distributed trace captured using OpenCensus. An exporter sends traces to any backend that is capable of consuming them. Recorded spans can be exported by registered exporters. |
samplingConfig | object | Distributed trace configuration for all API proxies in an environment. You can also override the configuration for a specific API proxy using the distributed trace configuration overrides API. (id: GoogleCloudApigeeV1TraceSamplingConfig) |
Methods
The following methods are available for this resource:
| Name | Accessible by | Required Params | Optional Params | Description |
|---|---|---|---|---|
organizations_environments_get_trace_config | select | organizationsId, environmentsId | Get distributed trace configuration in an environment. | |
organizations_environments_update_trace_config | update | organizationsId, environmentsId | updateMask | Updates the trace configurations in an environment. Note that the repeated fields have replace semantics when included in the field mask and that they will be overwritten by the value of the fields in the request body. |
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 |
|---|---|---|
environmentsId | string | |
organizationsId | string | |
updateMask | string (google-fieldmask) |
SELECT examples
- organizations_environments_get_trace_config
Get distributed trace configuration in an environment.
SELECT
endpoint,
exporter,
samplingConfig
FROM google.apigee.environments_trace_config
WHERE organizationsId = '{{ organizationsId }}' -- required
AND environmentsId = '{{ environmentsId }}' -- required;
UPDATE examples
- organizations_environments_update_trace_config
Updates the trace configurations in an environment. Note that the repeated fields have replace semantics when included in the field mask and that they will be overwritten by the value of the fields in the request body.
UPDATE google.apigee.environments_trace_config
SET
data__exporter = '{{ exporter }}',
data__endpoint = '{{ endpoint }}',
data__samplingConfig = '{{ samplingConfig }}'
WHERE
organizationsId = '{{ organizationsId }}' --required
AND environmentsId = '{{ environmentsId }}' --required
AND updateMask = '{{ updateMask}}'
RETURNING
endpoint,
exporter,
samplingConfig;