@datafire/amazonaws_xray NPM

@datafire/amazonaws_xray

Client library for AWS X-Ray

Installation and Usage

npm install --save @datafire/amazonaws_xray

let amazonaws_xray = require('@datafire/amazonaws_xray').create({
  accessKeyId: "",
  secretAccessKey: "",
  region: ""
});

amazonaws_xray.GetServiceGraph({
  "StartTime": "",
  "EndTime": ""
}).then(data => {
  console.log(data);
});

Description

AWS X-Ray provides APIs for managing debug traces and retrieving service maps and other data created by processing those traces.

Actions

GetServiceGraph

amazonaws_xray.GetServiceGraph({
  "StartTime": "",
  "EndTime": ""
}, context)

Input

input object
- NextToken string
- EndTime required Timestamp
- NextToken String
- StartTime required Timestamp

Output

output GetServiceGraphResult

PutTelemetryRecords

amazonaws_xray.PutTelemetryRecords({
  "TelemetryRecords": []
}, context)

Input

input object
- EC2InstanceId EC2InstanceId
- Hostname Hostname
- ResourceARN ResourceARN
- TelemetryRecords required TelemetryRecordList

Output

output PutTelemetryRecordsResult

GetTraceGraph

amazonaws_xray.GetTraceGraph({
  "TraceIds": []
}, context)

Input

input object
- NextToken string
- NextToken String
- TraceIds required TraceIdList

Output

output GetTraceGraphResult

PutTraceSegments

amazonaws_xray.PutTraceSegments({
  "TraceSegmentDocuments": []
}, context)

Input

input object
- TraceSegmentDocuments required TraceSegmentDocumentList

Output

output PutTraceSegmentsResult

GetTraceSummaries

amazonaws_xray.GetTraceSummaries({
  "StartTime": "",
  "EndTime": ""
}, context)

Input

input object
- NextToken string
- EndTime required Timestamp
- FilterExpression FilterExpression
- NextToken String
- Sampling NullableBoolean
- StartTime required Timestamp

Output

output GetTraceSummariesResult

BatchGetTraces

amazonaws_xray.BatchGetTraces({
  "TraceIds": []
}, context)

Input

input object
- NextToken string
- NextToken String
- TraceIds required TraceIdList

Output

output BatchGetTracesResult

Definitions

Alias

Alias object: An alias for an edge.
- Name String
- Names AliasNames
- Type String

AliasList

AliasList array
- items Alias

AliasNames

AliasNames array
- items String

AnnotationKey

AnnotationKey string

AnnotationValue

AnnotationValue object: Value of a segment annotation. Has one of three value types: Number, Boolean or String.
- BooleanValue NullableBoolean
- NumberValue NullableDouble
- StringValue String

Annotations

Annotations array
- items object
  - key AnnotationKey
  - value ValuesWithServiceIds

BackendConnectionErrors

BackendConnectionErrors object:
- ConnectionRefusedCount NullableInteger
- HTTPCode4XXCount NullableInteger
- HTTPCode5XXCount NullableInteger
- OtherCount NullableInteger
- TimeoutCount NullableInteger
- UnknownHostCount NullableInteger

BatchGetTracesRequest

BatchGetTracesRequest object
- NextToken String
- TraceIds required TraceIdList

BatchGetTracesResult

BatchGetTracesResult object
- NextToken String
- Traces TraceList
- UnprocessedTraceIds UnprocessedTraceIdList

Double

Double number

EC2InstanceId

EC2InstanceId string

Edge

Edge object: Information about a connection between two services.
- Aliases AliasList
- EndTime Timestamp
- ReferenceId NullableInteger
- ResponseTimeHistogram Histogram
- StartTime Timestamp
- SummaryStatistics EdgeStatistics

EdgeList

EdgeList array
- items Edge

EdgeStatistics

EdgeStatistics object: Response statistics for an edge.
- ErrorStatistics ErrorStatistics
- FaultStatistics FaultStatistics
- OkCount NullableLong
- TotalCount NullableLong
- TotalResponseTime NullableDouble

ErrorMessage

ErrorMessage string

ErrorStatistics

ErrorStatistics object: Information about requests that failed with a 4xx Client Error status code.
- OtherCount NullableLong
- ThrottleCount NullableLong
- TotalCount NullableLong

FaultStatistics

FaultStatistics object: Information about requests that failed with a 5xx Server Error status code.
- OtherCount NullableLong
- TotalCount NullableLong

FilterExpression

FilterExpression string

GetServiceGraphRequest

GetServiceGraphRequest object
- EndTime required Timestamp
- NextToken String
- StartTime required Timestamp

GetServiceGraphResult

GetServiceGraphResult object
- EndTime Timestamp
- NextToken String
- Services ServiceList
- StartTime Timestamp

GetTraceGraphRequest

GetTraceGraphRequest object
- NextToken String
- TraceIds required TraceIdList

GetTraceGraphResult

GetTraceGraphResult object
- NextToken String
- Services ServiceList

GetTraceSummariesRequest

GetTraceSummariesRequest object
- EndTime required Timestamp
- FilterExpression FilterExpression
- NextToken String
- Sampling NullableBoolean
- StartTime required Timestamp

GetTraceSummariesResult

GetTraceSummariesResult object
- ApproximateTime Timestamp
- NextToken String
- TraceSummaries TraceSummaryList
- TracesProcessedCount NullableLong

Histogram

Histogram array
- items HistogramEntry

HistogramEntry

HistogramEntry object: An entry in a histogram for a statistic. A histogram maps the range of observed values on the X axis, and the prevalence of each value on the Y axis.
- Count Integer
- Value Double

Hostname

Hostname string

Http

Http object: Information about an HTTP request.
- ClientIp String
- HttpMethod String
- HttpStatus NullableInteger
- HttpURL String
- UserAgent String

Integer

Integer integer

InvalidRequestException

InvalidRequestException object: The request is missing required parameters or has invalid parameters.
- Message ErrorMessage

NullableBoolean

NullableBoolean boolean

NullableDouble

NullableDouble number

NullableInteger

NullableInteger integer

NullableLong

NullableLong integer

PutTelemetryRecordsRequest

PutTelemetryRecordsRequest object
- EC2InstanceId EC2InstanceId
- Hostname Hostname
- ResourceARN ResourceARN
- TelemetryRecords required TelemetryRecordList

PutTelemetryRecordsResult

PutTelemetryRecordsResult object

PutTraceSegmentsRequest

PutTraceSegmentsRequest object
- TraceSegmentDocuments required TraceSegmentDocumentList

PutTraceSegmentsResult

PutTraceSegmentsResult object
- UnprocessedTraceSegments UnprocessedTraceSegmentList

ResourceARN

ResourceARN string

Segment

Segment object: A segment from a trace that has been ingested by the X-Ray service. The segment can be compiled from documents uploaded with PutTraceSegments, or an inferred segment for a downstream service, generated from a subsegment sent by the service that called it.
- Document SegmentDocument
- Id SegmentId

SegmentDocument

SegmentDocument string

SegmentId

SegmentId string

SegmentList

SegmentList array
- items Segment

Service

Service object: Information about an application that processed requests, users that made requests, or downstream services, resources and applications that an application used.
- AccountId String
- DurationHistogram Histogram
- Edges EdgeList
- EndTime Timestamp
- Name String
- Names ServiceNames
- ReferenceId NullableInteger
- ResponseTimeHistogram Histogram
- Root NullableBoolean
- StartTime Timestamp
- State String
- SummaryStatistics ServiceStatistics
- Type String

ServiceId

ServiceId object:
- AccountId String
- Name String
- Names ServiceNames
- Type String

ServiceIds

ServiceIds array
- items ServiceId

ServiceList

ServiceList array
- items Service

ServiceNames

ServiceNames array
- items String

ServiceStatistics

ServiceStatistics object: Response statistics for a service.
- ErrorStatistics ErrorStatistics
- FaultStatistics FaultStatistics
- OkCount NullableLong
- TotalCount NullableLong
- TotalResponseTime NullableDouble

String

String string

TelemetryRecord

TelemetryRecord object:
- BackendConnectionErrors BackendConnectionErrors
- SegmentsReceivedCount NullableInteger
- SegmentsRejectedCount NullableInteger
- SegmentsSentCount NullableInteger
- SegmentsSpilloverCount NullableInteger
- Timestamp required Timestamp