Xray

This page documents function available when using the Xray module, created with @service Xray.

Index

Documentation

Main.Xray.batch_get_tracesMethod
batch_get_traces(trace_ids)
batch_get_traces(trace_ids, params::Dict{String,<:Any})

Retrieves a list of traces specified by ID. Each trace is a collection of segment documents that originates from a single request. Use GetTraceSummaries to get a list of trace IDs.

Arguments

  • trace_ids: Specify the trace IDs of requests for which to retrieve segments.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "NextToken": Pagination token.
Main.Xray.create_groupMethod
create_group(group_name)
create_group(group_name, params::Dict{String,<:Any})

Creates a group resource with a name and a filter expression.

Arguments

  • group_name: The case-sensitive name of the new group. Default is a reserved name and names must be unique.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "FilterExpression": The filter expression defining criteria by which to group traces.
  • "InsightsConfiguration": The structure containing configurations related to insights. The InsightsEnabled boolean can be set to true to enable insights for the new group or false to disable insights for the new group. The NotificationsEnabled boolean can be set to true to enable insights notifications for the new group. Notifications may only be enabled on a group with InsightsEnabled set to true.
  • "Tags": A map that contains one or more tag keys and tag values to attach to an X-Ray group. For more information about ways to use tags, see Tagging Amazon Web Services resources in the Amazon Web Services General Reference. The following restrictions apply to tags: Maximum number of user-applied tags per resource: 50 Maximum tag key length: 128 Unicode characters Maximum tag value length: 256 Unicode characters Valid values for key and value: a-z, A-Z, 0-9, space, and the following characters: _ . : / = + - and @ Tag keys and values are case sensitive. Don't use aws: as a prefix for keys; it's reserved for Amazon Web Services use.
Main.Xray.create_sampling_ruleMethod
create_sampling_rule(sampling_rule)
create_sampling_rule(sampling_rule, params::Dict{String,<:Any})

Creates a rule to control sampling behavior for instrumented applications. Services retrieve rules with GetSamplingRules, and evaluate each rule in ascending order of priority for each request. If a rule matches, the service records a trace, borrowing it from the reservoir size. After 10 seconds, the service reports back to X-Ray with GetSamplingTargets to get updated versions of each in-use rule. The updated rule contains a trace quota that the service can use instead of borrowing from the reservoir.

Arguments

  • sampling_rule: The rule definition.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "Tags": A map that contains one or more tag keys and tag values to attach to an X-Ray sampling rule. For more information about ways to use tags, see Tagging Amazon Web Services resources in the Amazon Web Services General Reference. The following restrictions apply to tags: Maximum number of user-applied tags per resource: 50 Maximum tag key length: 128 Unicode characters Maximum tag value length: 256 Unicode characters Valid values for key and value: a-z, A-Z, 0-9, space, and the following characters: _ . : / = + - and @ Tag keys and values are case sensitive. Don't use aws: as a prefix for keys; it's reserved for Amazon Web Services use.
Main.Xray.delete_groupMethod
delete_group()
delete_group(params::Dict{String,<:Any})

Deletes a group resource.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "GroupARN": The ARN of the group that was generated on creation.
  • "GroupName": The case-sensitive name of the group.
Main.Xray.delete_resource_policyMethod
delete_resource_policy(policy_name)
delete_resource_policy(policy_name, params::Dict{String,<:Any})

Deletes a resource policy from the target Amazon Web Services account.

Arguments

  • policy_name: The name of the resource policy to delete.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "PolicyRevisionId": Specifies a specific policy revision to delete. Provide a PolicyRevisionId to ensure an atomic delete operation. If the provided revision id does not match the latest policy revision id, an InvalidPolicyRevisionIdException exception is returned.
Main.Xray.delete_sampling_ruleMethod
delete_sampling_rule()
delete_sampling_rule(params::Dict{String,<:Any})

Deletes a sampling rule.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "RuleARN": The ARN of the sampling rule. Specify a rule by either name or ARN, but not both.
  • "RuleName": The name of the sampling rule. Specify a rule by either name or ARN, but not both.
Main.Xray.get_encryption_configMethod
get_encryption_config()
get_encryption_config(params::Dict{String,<:Any})

Retrieves the current encryption configuration for X-Ray data.

Main.Xray.get_groupMethod
get_group()
get_group(params::Dict{String,<:Any})

Retrieves group resource details.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "GroupARN": The ARN of the group that was generated on creation.
  • "GroupName": The case-sensitive name of the group.
Main.Xray.get_groupsMethod
get_groups()
get_groups(params::Dict{String,<:Any})

Retrieves all active group details.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "NextToken": Pagination token.
Main.Xray.get_insightMethod
get_insight(insight_id)
get_insight(insight_id, params::Dict{String,<:Any})

Retrieves the summary information of an insight. This includes impact to clients and root cause services, the top anomalous services, the category, the state of the insight, and the start and end time of the insight.

Arguments

  • insight_id: The insight's unique identifier. Use the GetInsightSummaries action to retrieve an InsightId.
Main.Xray.get_insight_eventsMethod
get_insight_events(insight_id)
get_insight_events(insight_id, params::Dict{String,<:Any})

X-Ray reevaluates insights periodically until they're resolved, and records each intermediate state as an event. You can review an insight's events in the Impact Timeline on the Inspect page in the X-Ray console.

Arguments

  • insight_id: The insight's unique identifier. Use the GetInsightSummaries action to retrieve an InsightId.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "MaxResults": Used to retrieve at most the specified value of events.
  • "NextToken": Specify the pagination token returned by a previous request to retrieve the next page of events.
Main.Xray.get_insight_impact_graphMethod
get_insight_impact_graph(end_time, insight_id, start_time)
get_insight_impact_graph(end_time, insight_id, start_time, params::Dict{String,<:Any})

Retrieves a service graph structure filtered by the specified insight. The service graph is limited to only structural information. For a complete service graph, use this API with the GetServiceGraph API.

Arguments

  • end_time: The estimated end time of the insight, in Unix time seconds. The EndTime is exclusive of the value provided. The time range between the start time and end time can't be more than six hours.
  • insight_id: The insight's unique identifier. Use the GetInsightSummaries action to retrieve an InsightId.
  • start_time: The estimated start time of the insight, in Unix time seconds. The StartTime is inclusive of the value provided and can't be more than 30 days old.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "NextToken": Specify the pagination token returned by a previous request to retrieve the next page of results.
Main.Xray.get_insight_summariesMethod
get_insight_summaries(end_time, start_time)
get_insight_summaries(end_time, start_time, params::Dict{String,<:Any})

Retrieves the summaries of all insights in the specified group matching the provided filter values.

Arguments

  • end_time: The end of the time frame in which the insights ended. The end time can't be more than 30 days old.
  • start_time: The beginning of the time frame in which the insights started. The start time can't be more than 30 days old.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "GroupARN": The Amazon Resource Name (ARN) of the group. Required if the GroupName isn't provided.
  • "GroupName": The name of the group. Required if the GroupARN isn't provided.
  • "MaxResults": The maximum number of results to display.
  • "NextToken": Pagination token.
  • "States": The list of insight states.
Main.Xray.get_sampling_rulesMethod
get_sampling_rules()
get_sampling_rules(params::Dict{String,<:Any})

Retrieves all sampling rules.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "NextToken": Pagination token.
Main.Xray.get_sampling_statistic_summariesMethod
get_sampling_statistic_summaries()
get_sampling_statistic_summaries(params::Dict{String,<:Any})

Retrieves information about recent sampling results for all sampling rules.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "NextToken": Pagination token.
Main.Xray.get_sampling_targetsMethod
get_sampling_targets(sampling_statistics_documents)
get_sampling_targets(sampling_statistics_documents, params::Dict{String,<:Any})

Requests a sampling quota for rules that the service is using to sample requests.

Arguments

  • sampling_statistics_documents: Information about rules that the service is using to sample requests.
Main.Xray.get_service_graphMethod
get_service_graph(end_time, start_time)
get_service_graph(end_time, start_time, params::Dict{String,<:Any})

Retrieves a document that describes services that process incoming requests, and downstream services that they call as a result. Root services process incoming requests and make calls to downstream services. Root services are applications that use the Amazon Web Services X-Ray SDK. Downstream services can be other applications, Amazon Web Services resources, HTTP web APIs, or SQL databases.

Arguments

  • end_time: The end of the timeframe for which to generate a graph.
  • start_time: The start of the time frame for which to generate a graph.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "GroupARN": The Amazon Resource Name (ARN) of a group based on which you want to generate a graph.
  • "GroupName": The name of a group based on which you want to generate a graph.
  • "NextToken": Pagination token.
Main.Xray.get_time_series_service_statisticsMethod
get_time_series_service_statistics(end_time, start_time)
get_time_series_service_statistics(end_time, start_time, params::Dict{String,<:Any})

Get an aggregation of service statistics defined by a specific time range.

Arguments

  • end_time: The end of the time frame for which to aggregate statistics.
  • start_time: The start of the time frame for which to aggregate statistics.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "EntitySelectorExpression": A filter expression defining entities that will be aggregated for statistics. Supports ID, service, and edge functions. If no selector expression is specified, edge statistics are returned.
  • "ForecastStatistics": The forecasted high and low fault count values. Forecast enabled requests require the EntitySelectorExpression ID be provided.
  • "GroupARN": The Amazon Resource Name (ARN) of the group for which to pull statistics from.
  • "GroupName": The case-sensitive name of the group for which to pull statistics from.
  • "NextToken": Pagination token.
  • "Period": Aggregation period in seconds.
Main.Xray.get_trace_graphMethod
get_trace_graph(trace_ids)
get_trace_graph(trace_ids, params::Dict{String,<:Any})

Retrieves a service graph for one or more specific trace IDs.

Arguments

  • trace_ids: Trace IDs of requests for which to generate a service graph.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "NextToken": Pagination token.
Main.Xray.get_trace_summariesMethod
get_trace_summaries(end_time, start_time)
get_trace_summaries(end_time, start_time, params::Dict{String,<:Any})

Retrieves IDs and annotations for traces available for a specified time frame using an optional filter. To get the full traces, pass the trace IDs to BatchGetTraces. A filter expression can target traced requests that hit specific service nodes or edges, have errors, or come from a known user. For example, the following filter expression targets traces that pass through api.example.com: service("api.example.com") This filter expression finds traces that have an annotation named account with the value 12345: annotation.account = "12345" For a full list of indexed fields and keywords that you can use in filter expressions, see Using Filter Expressions in the Amazon Web Services X-Ray Developer Guide.

Arguments

  • end_time: The end of the time frame for which to retrieve traces.
  • start_time: The start of the time frame for which to retrieve traces.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "FilterExpression": Specify a filter expression to retrieve trace summaries for services or requests that meet certain requirements.
  • "NextToken": Specify the pagination token returned by a previous request to retrieve the next page of results.
  • "Sampling": Set to true to get summaries for only a subset of available traces.
  • "SamplingStrategy": A parameter to indicate whether to enable sampling on trace summaries. Input parameters are Name and Value.
  • "TimeRangeType": A parameter to indicate whether to query trace summaries by TraceId or Event time.
Main.Xray.list_resource_policiesMethod
list_resource_policies()
list_resource_policies(params::Dict{String,<:Any})

Returns the list of resource policies in the target Amazon Web Services account.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "NextToken": Not currently supported.
Main.Xray.list_tags_for_resourceMethod
list_tags_for_resource(resource_arn)
list_tags_for_resource(resource_arn, params::Dict{String,<:Any})

Returns a list of tags that are applied to the specified Amazon Web Services X-Ray group or sampling rule.

Arguments

  • resource_arn: The Amazon Resource Number (ARN) of an X-Ray group or sampling rule.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "NextToken": A pagination token. If multiple pages of results are returned, use the NextToken value returned with the current page of results as the value of this parameter to get the next page of results.
Main.Xray.put_encryption_configMethod
put_encryption_config(type)
put_encryption_config(type, params::Dict{String,<:Any})

Updates the encryption configuration for X-Ray data.

Arguments

  • type: The type of encryption. Set to KMS to use your own key for encryption. Set to NONE for default encryption.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "KeyId": An Amazon Web Services KMS key in one of the following formats: Alias - The name of the key. For example, alias/MyKey. Key ID - The KMS key ID of the key. For example, ae4aa6d49-a4d8-9df9-a475-4ff6d7898456. Amazon Web Services X-Ray does not support asymmetric KMS keys. ARN - The full Amazon Resource Name of the key ID or alias. For example, arn:aws:kms:us-east-2:123456789012:key/ae4aa6d49-a4d8-9df9-a475-4ff6d7898456. Use this format to specify a key in a different account. Omit this key if you set Type to NONE.
Main.Xray.put_resource_policyMethod
put_resource_policy(policy_document, policy_name)
put_resource_policy(policy_document, policy_name, params::Dict{String,<:Any})

Sets the resource policy to grant one or more Amazon Web Services services and accounts permissions to access X-Ray. Each resource policy will be associated with a specific Amazon Web Services account. Each Amazon Web Services account can have a maximum of 5 resource policies, and each policy name must be unique within that account. The maximum size of each resource policy is 5KB.

Arguments

  • policy_document: The resource policy document, which can be up to 5kb in size.
  • policy_name: The name of the resource policy. Must be unique within a specific Amazon Web Services account.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "BypassPolicyLockoutCheck": A flag to indicate whether to bypass the resource policy lockout safety check. Setting this value to true increases the risk that the policy becomes unmanageable. Do not set this value to true indiscriminately. Use this parameter only when you include a policy in the request and you intend to prevent the principal that is making the request from making a subsequent PutResourcePolicy request. The default value is false.
  • "PolicyRevisionId": Specifies a specific policy revision, to ensure an atomic create operation. By default the resource policy is created if it does not exist, or updated with an incremented revision id. The revision id is unique to each policy in the account. If the policy revision id does not match the latest revision id, the operation will fail with an InvalidPolicyRevisionIdException exception. You can also provide a PolicyRevisionId of 0. In this case, the operation will fail with an InvalidPolicyRevisionIdException exception if a resource policy with the same name already exists.
Main.Xray.put_telemetry_recordsMethod
put_telemetry_records(telemetry_records)
put_telemetry_records(telemetry_records, params::Dict{String,<:Any})

Used by the Amazon Web Services X-Ray daemon to upload telemetry.

Arguments

  • telemetry_records:

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "EC2InstanceId":
  • "Hostname":
  • "ResourceARN":
Main.Xray.put_trace_segmentsMethod
put_trace_segments(trace_segment_documents)
put_trace_segments(trace_segment_documents, params::Dict{String,<:Any})

Uploads segment documents to Amazon Web Services X-Ray. The X-Ray SDK generates segment documents and sends them to the X-Ray daemon, which uploads them in batches. A segment document can be a completed segment, an in-progress segment, or an array of subsegments. Segments must include the following fields. For the full segment document schema, see Amazon Web Services X-Ray Segment Documents in the Amazon Web Services X-Ray Developer Guide. Required segment document fields name - The name of the service that handled the request. id - A 64-bit identifier for the segment, unique among segments in the same trace, in 16 hexadecimal digits. traceid - A unique identifier that connects all segments and subsegments originating from a single client request. starttime - Time the segment or subsegment was created, in floating point seconds in epoch time, accurate to milliseconds. For example, 1480615200.010 or 1.480615200010E9. endtime - Time the segment or subsegment was closed. For example, 1480615200.090 or 1.480615200090E9. Specify either an endtime or inprogress. inprogress - Set to true instead of specifying an endtime to record that a segment has been started, but is not complete. Send an in-progress segment when your application receives a request that will take a long time to serve, to trace that the request was received. When the response is sent, send the complete segment to overwrite the in-progress segment. A traceid consists of three numbers separated by hyphens. For example, 1-58406520-a006649127e371903a2de979. This includes: Trace ID Format The version number, for instance, 1. The time of the original request, in Unix epoch time, in 8 hexadecimal digits. For example, 10:00AM December 2nd, 2016 PST in epoch time is 1480615200 seconds, or 58406520 in hexadecimal. A 96-bit identifier for the trace, globally unique, in 24 hexadecimal digits.

Arguments

  • trace_segment_documents: A string containing a JSON document defining one or more segments or subsegments.
Main.Xray.tag_resourceMethod
tag_resource(resource_arn, tags)
tag_resource(resource_arn, tags, params::Dict{String,<:Any})

Applies tags to an existing Amazon Web Services X-Ray group or sampling rule.

Arguments

  • resource_arn: The Amazon Resource Number (ARN) of an X-Ray group or sampling rule.
  • tags: A map that contains one or more tag keys and tag values to attach to an X-Ray group or sampling rule. For more information about ways to use tags, see Tagging Amazon Web Services resources in the Amazon Web Services General Reference. The following restrictions apply to tags: Maximum number of user-applied tags per resource: 50 Maximum tag key length: 128 Unicode characters Maximum tag value length: 256 Unicode characters Valid values for key and value: a-z, A-Z, 0-9, space, and the following characters: _ . : / = + - and @ Tag keys and values are case sensitive. Don't use aws: as a prefix for keys; it's reserved for Amazon Web Services use. You cannot edit or delete system tags.
Main.Xray.untag_resourceMethod
untag_resource(resource_arn, tag_keys)
untag_resource(resource_arn, tag_keys, params::Dict{String,<:Any})

Removes tags from an Amazon Web Services X-Ray group or sampling rule. You cannot edit or delete system tags (those with an aws: prefix).

Arguments

  • resource_arn: The Amazon Resource Number (ARN) of an X-Ray group or sampling rule.
  • tag_keys: Keys for one or more tags that you want to remove from an X-Ray group or sampling rule.
Main.Xray.update_groupMethod
update_group()
update_group(params::Dict{String,<:Any})

Updates a group resource.

Optional Parameters

Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:

  • "FilterExpression": The updated filter expression defining criteria by which to group traces.
  • "GroupARN": The ARN that was generated upon creation.
  • "GroupName": The case-sensitive name of the group.
  • "InsightsConfiguration": The structure containing configurations related to insights. The InsightsEnabled boolean can be set to true to enable insights for the group or false to disable insights for the group. The NotificationsEnabled boolean can be set to true to enable insights notifications for the group. Notifications can only be enabled on a group with InsightsEnabled set to true.
Main.Xray.update_sampling_ruleMethod
update_sampling_rule(sampling_rule_update)
update_sampling_rule(sampling_rule_update, params::Dict{String,<:Any})

Modifies a sampling rule's configuration.

Arguments

  • sampling_rule_update: The rule and fields to change.