AWS X-Ray
Amazon Web Services X-Ray provides APIs for managing debug traces and retrieving service maps and other data created by processing those traces.
xray(config = list(), credentials = list(), endpoint = NULL, region = NULL)
config: Optional configuration of credentials, endpoint, and/or region.
credentials :
creds :
profile : The name of a profile to use. If not given, then the default profile is used.
anonymous : Set anonymous credentials.
endpoint : The complete URL to use for the constructed client.
region : The AWS Region used in instantiating the client.
close_connection : Immediately close all HTTP connections.
timeout : The time in seconds till a timeout exception is thrown when attempting to make a connection. The default is 60 seconds.
s3_force_path_style : Set this to true to force the request to use path-style addressing, i.e. http://s3.amazonaws.com/BUCKET/KEY.
sts_regional_endpoint : Set sts regional endpoint resolver to regional or legacy https://docs.aws.amazon.com/sdkref/latest/guide/feature-sts-regionalized-endpoints.html
credentials: Optional credentials shorthand for the config parameter
creds :
profile : The name of a profile to use. If not given, then the default profile is used.
anonymous : Set anonymous credentials.
endpoint: Optional shorthand for complete URL to use for the constructed client.
region: Optional shorthand for AWS Region used in instantiating the client.
A client for the service. You can call the service's operations using syntax like svc$operation(...), where svc is the name you've assigned to the client. The available operations are listed in the Operations section.
svc <- xray(
config = list(
credentials = list(
creds = list(
access_key_id = "string",
secret_access_key = "string",
session_token = "string"
),
profile = "string",
anonymous = "logical"
),
endpoint = "string",
region = "string",
close_connection = "logical",
timeout = "numeric",
s3_force_path_style = "logical",
sts_regional_endpoint = "string"
),
credentials = list(
creds = list(
access_key_id = "string",
secret_access_key = "string",
session_token = "string"
),
profile = "string",
anonymous = "logical"
),
endpoint = "string",
region = "string"
)
| batch_get_traces | You cannot find traces through this API if Transaction Search is enabled since trace is not indexed in X-Ray |
| cancel_trace_retrieval | Cancels an ongoing trace retrieval job initiated by StartTraceRetrieval using the provided RetrievalToken |
| create_group | Creates a group resource with a name and a filter expression |
| create_sampling_rule | Creates a rule to control sampling behavior for instrumented applications |
| delete_group | Deletes a group resource |
| delete_resource_policy | Deletes a resource policy from the target Amazon Web Services account |
| delete_sampling_rule | Deletes a sampling rule |
| get_encryption_config | Retrieves the current encryption configuration for X-Ray data |
| get_group | Retrieves group resource details |
| get_groups | Retrieves all active group details |
| get_indexing_rules | Retrieves all indexing rules |
| get_insight | Retrieves the summary information of an insight |
| get_insight_events | X-Ray reevaluates insights periodically until they're resolved, and records each intermediate state as an event |
| get_insight_impact_graph | Retrieves a service graph structure filtered by the specified insight |
| get_insight_summaries | Retrieves the summaries of all insights in the specified group matching the provided filter values |
| get_retrieved_traces_graph | Retrieves a service graph for traces based on the specified RetrievalToken from the CloudWatch log group generated by Transaction Search |
| get_sampling_rules | Retrieves all sampling rules |
| get_sampling_statistic_summaries | Retrieves information about recent sampling results for all sampling rules |
| get_sampling_targets | Requests a sampling quota for rules that the service is using to sample requests |
| get_service_graph | Retrieves a document that describes services that process incoming requests, and downstream services that they call as a result |
| get_time_series_service_statistics | Get an aggregation of service statistics defined by a specific time range |
| get_trace_graph | Retrieves a service graph for one or more specific trace IDs |
| get_trace_segment_destination | Retrieves the current destination of data sent to PutTraceSegments and OpenTelemetry API |
| get_trace_summaries | Retrieves IDs and annotations for traces available for a specified time frame using an optional filter |
| list_resource_policies | Returns the list of resource policies in the target Amazon Web Services account |
| list_retrieved_traces | Retrieves a list of traces for a given RetrievalToken from the CloudWatch log group generated by Transaction Search |
| list_tags_for_resource | Returns a list of tags that are applied to the specified Amazon Web Services X-Ray group or sampling rule |
| put_encryption_config | Updates the encryption configuration for X-Ray data |
| put_resource_policy | Sets the resource policy to grant one or more Amazon Web Services services and accounts permissions to access X-Ray |
| put_telemetry_records | Used by the Amazon Web Services X-Ray daemon to upload telemetry |
| put_trace_segments | Uploads segment documents to Amazon Web Services X-Ray |
| start_trace_retrieval | Initiates a trace retrieval process using the specified time range and for the give trace IDs on Transaction Search generated by the CloudWatch log group |
| tag_resource | Applies tags to an existing Amazon Web Services X-Ray group or sampling rule |
| untag_resource | Removes tags from an Amazon Web Services X-Ray group or sampling rule |
| update_group | Updates a group resource |
| update_indexing_rule | Modifies an indexing rule’s configuration |
| update_sampling_rule | Modifies a sampling rule's configuration |
| update_trace_segment_destination | Modifies the destination of data sent to PutTraceSegments |
## Not run: svc <- xray() svc$batch_get_traces( Foo = 123 ) ## End(Not run)
Useful links