flowground for Business Customers
AWS X-Ray
Connector for

AWS X-Ray

AWS X-Ray provides APIs for managing debug traces and retrieving service maps and other data created by processing those traces.
Specifications
  • Category: Office
  • Provider: n/a
  • Used API: -
  • Managed: -
  • License: Apache License 2.0
  • Programmed with: javascript
Prices

For productive use you need a project room, which is subject to a fee.

Prices & Editions

Technical Specifications

startFlow

OnInit
./lib/triggers/startFlow.js
OnStartup
-
OnClose
-

Attributes

-

CreateGroup

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

OnInit
./lib/actions/CreateGroup.js
OnStartup
-
OnClose
-

Attributes

-

CreateSamplingRule

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.

OnInit
./lib/actions/CreateSamplingRule.js
OnStartup
-
OnClose
-

Attributes

-

DeleteGroup

Deletes a group resource.

OnInit
./lib/actions/DeleteGroup.js
OnStartup
-
OnClose
-

Attributes

-

DeleteSamplingRule

Deletes a sampling rule.

OnInit
./lib/actions/DeleteSamplingRule.js
OnStartup
-
OnClose
-

Attributes

-

GetEncryptionConfig

Retrieves the current encryption configuration for X-Ray data.

OnInit
./lib/actions/GetEncryptionConfig.js
OnStartup
-
OnClose
-

Attributes

-

GetGroup

Retrieves group resource details.

OnInit
./lib/actions/GetGroup.js
OnStartup
-
OnClose
-

Attributes

-

GetSamplingRules

Retrieves all sampling rules.

OnInit
./lib/actions/GetSamplingRules.js
OnStartup
-
OnClose
-

Attributes

-

GetGroups

Retrieves all active group details.

OnInit
./lib/actions/GetGroups.js
OnStartup
-
OnClose
-

Attributes

-

PutEncryptionConfig

Updates the encryption configuration for X-Ray data.

OnInit
./lib/actions/PutEncryptionConfig.js
OnStartup
-
OnClose
-

Attributes

-

GetSamplingStatisticSummaries

Retrieves information about recent sampling results for all sampling rules.

OnInit
./lib/actions/GetSamplingStatisticSummaries.js
OnStartup
-
OnClose
-

Attributes

-

GetSamplingTargets

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

OnInit
./lib/actions/GetSamplingTargets.js
OnStartup
-
OnClose
-

Attributes

-

GetServiceGraph

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 AWS X-Ray SDK. Downstream services can be other applications, AWS resources, HTTP web APIs, or SQL databases.

OnInit
./lib/actions/GetServiceGraph.js
OnStartup
-
OnClose
-

Attributes

-

PutTelemetryRecords

Used by the AWS X-Ray daemon to upload telemetry.

OnInit
./lib/actions/PutTelemetryRecords.js
OnStartup
-
OnClose
-

Attributes

-

GetTraceGraph

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

OnInit
./lib/actions/GetTraceGraph.js
OnStartup
-
OnClose
-

Attributes

-

PutTraceSegments

Uploads segment documents to AWS 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 AWS X-Ray Segment Documents in the AWS 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.

  • trace_id - A unique identifier that connects all segments and subsegments originating from a single client request.

  • start_time - Time the segment or subsegment was created, in floating point seconds in epoch time, accurate to milliseconds. For example, 1480615200.010 or 1.480615200010E9.

  • end_time - Time the segment or subsegment was closed. For example, 1480615200.090 or 1.480615200090E9. Specify either an end_time or in_progress.

  • in_progress - Set to true instead of specifying an end_time 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 the fact that the request was received. When the response is sent, send the complete segment to overwrite the in-progress segment.

A trace_id consists of three numbers separated by hyphens. For example, 1-58406520-a006649127e371903a2de979. This includes:

Trace ID Format

  • The version number, i.e. 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.

OnInit
./lib/actions/PutTraceSegments.js
OnStartup
-
OnClose
-

Attributes

-

GetTraceSummaries

Retrieves IDs and metadata 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 AWS X-Ray Developer Guide.

OnInit
./lib/actions/GetTraceSummaries.js
OnStartup
-
OnClose
-

Attributes

-

BatchGetTraces

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.

OnInit
./lib/actions/BatchGetTraces.js
OnStartup
-
OnClose
-

Attributes

-

UpdateGroup

Updates a group resource.

OnInit
./lib/actions/UpdateGroup.js
OnStartup
-
OnClose
-

Attributes

-

UpdateSamplingRule

Modifies a sampling rule's configuration.

OnInit
./lib/actions/UpdateSamplingRule.js
OnStartup
-
OnClose
-

Attributes

-

No data available for terms

No data available for environment

You have any technical questions about the platform?

Technical documentation of the platform, online tutorials and more can be found here.

We are happy to bring you together directly with the flowground experts:

To contact form