schema

package
v1.8.1 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Jun 26, 2024 License: MIT Imports: 1 Imported by: 2

Documentation

Overview

Package schema provides types for AWS X-Ray Segment Documents.

Index

Constants

View Source 
const (
	OriginEC2Instance      = "AWS::EC2::Instance"                 // An Amazon EC2 instance.
	OriginECSContainer     = "AWS::ECS::Container"                // An Amazon ECS container.
	OriginEKSContainer     = "AWS::EKS::Container"                // An Amazon EKS container.
	OriginElasticBeanstalk = "AWS::ElasticBeanstalk::Environment" // An Elastic Beanstalk environment.
)

The value of Segment.Origin.

Variables

This section is empty.

Functions

This section is empty.

Types

type AWS 

type AWS map[string]any

AWS is information about the AWS resource on which your application served the request.

func (AWS) AccountID 

func (aws AWS) AccountID() string

AccountID return the ID of the account running your application if your application sends segments to a different AWS account.

func (AWS) AddLogReferences added in v1.1.0 

func (aws AWS) AddLogReferences(logs []*LogReference)

AddLogReferences adds information about Amazon CloudWatch Logs.

func (AWS) Get 

func (aws AWS) Get(key string) any

Get returns the value named the key.

func (AWS) Set 

func (aws AWS) Set(key string, value any)

Set set the value.

func (AWS) SetAccountID 

func (aws AWS) SetAccountID(accountID string)

SetAccountID sets AccountID.

func (AWS) SetEC2 

func (aws AWS) SetEC2(ec2 *EC2)

SetEC2 sets EC2.

func (AWS) SetECS 

func (aws AWS) SetECS(ecs *ECS)

SetECS sets ECS.

func (AWS) SetEKS added in v0.0.2 

func (aws AWS) SetEKS(eks *EKS)

SetEKS sets EKS.

func (AWS) SetElasticBeanstalk 

func (aws AWS) SetElasticBeanstalk(bean *ElasticBeanstalk)

SetElasticBeanstalk sets ElasticBeanstalk.

func (AWS) SetXRay 

func (aws AWS) SetXRay(xray *XRay)

SetXRay sets XRay.

type Cause 

type Cause struct {
	// The full path of the working directory when the exception occurred.
	WorkingDirectory string `json:"working_directory,omitempty"`

	// The array of paths to libraries or modules in use when the exception occurred.
	Paths []string `json:"paths,omitempty"`

	Exceptions []Exception `json:"exceptions,omitempty"`
}

Cause indicates the cause of the error by including a cause object in the segment or subsegment.

type EC2 

type EC2 struct {
	// The instance ID of the EC2 instance.
	InstanceID string `json:"instance_id,omitempty"`

	// The Availability Zone in which the instance is running.
	AvailabilityZone string `json:"availability_zone,omitempty"`

	// The instance type of the instance.
	InstanceSize string `json:"instance_size,omitempty"`

	// The Amazon Machine Image ID.
	AMIID string `json:"ami_id,omitempty"`
}

EC2 is information about an EC2 instance.

type ECS 

type ECS struct {
	// The hostname of your container.
	Container string `json:"container,omitempty"`

	// The full container ID of your container.
	ContainerID string `json:"container_id,omitempty"`

	// The ARN of your container instance.
	ContainerArn string `json:"container_arn,omitempty"`
}

ECS is information about an Amazon ECS container.

type EKS added in v0.0.2 

type EKS struct {
	// The hostname of your EKS pod.
	Pod string `json:"pod,omitempty"`

	// The EKS cluster name.
	ClusterName string `json:"cluster_name,omitempty"`

	// The full container ID of your container.
	ContainerID string `json:"container_id,omitempty"`
}

EKS is information about an Amazon EKS container.

type ElasticBeanstalk 

type ElasticBeanstalk struct {
	// The name of the environment.
	EnvironmentName string `json:"environment_name,omitempty"`

	// The name of the application version that is currently deployed to the instance that served the request.
	VersionLabel string `json:"version_label,omitempty"`

	// number indicating the ID of the last successful deployment to the instance that served the request.
	DeploymentID int64 `json:"deployment_id,omitempty"`
}

ElasticBeanstalk is information about an Elastic Beanstalk environment. You can find this information in a file named /var/elasticbeanstalk/xray/environment.conf on the latest Elastic Beanstalk platforms.

type Exception 

type Exception struct {
	// A 64-bit identifier for the exception, unique among segments in the same trace, in 16 hexadecimal digits.
	ID string `json:"id"`

	// The exception message.
	Message string `json:"message,omitempty"`

	// The exception type.
	Type string `json:"type,omitempty"`

	// boolean indicating that the exception was caused by an error returned by a downstream service.
	Remote bool `json:"remote,omitempty"`

	// integer indicating the number of stack frames that are omitted from the stack.
	Truncated int `json:"truncated,omitempty"`

	// integer indicating the number of exceptions that were skipped between this exception and its child, that is, the exception that it caused.
	Skipped int `json:"skipped,omitempty"`

	// Exception ID of the exception's parent, that is, the exception that caused this exception.
	Cause string `json:"cause,omitempty"`

	// array of stackFrame objects.
	Stack []StackFrame `json:"stack,omitempty"`
}

Exception is detailed information about the error.

type HTTP 

type HTTP struct {
	Request  *HTTPRequest  `json:"request,omitempty"`
	Response *HTTPResponse `json:"response,omitempty"`
}

HTTP is information about the original HTTP request.

type HTTPRequest 

type HTTPRequest struct {
	// The request method. For example, GET.
	Method string `json:"method,omitempty"`

	// The full URL of the request, compiled from the protocol, hostname, and path of the request.
	URL string `json:"url,omitempty"`

	// The user agent string from the requester's client.
	UserAgent string `json:"user_agent,omitempty"`

	// The IP address of the requester.
	// Can be retrieved from the IP packet's Source Address or, for forwarded requests, from an X-Forwarded-For header.
	ClientIP string `json:"client_ip,omitempty"`

	// (segments only) boolean indicating that the client_ip was read from an X-Forwarded-For header
	// and is not reliable as it could have been forged.
	XForwardedFor bool `json:"x_forwarded_for,omitempty"`

	// (subsegments only) boolean indicating that the downstream call is to another traced service.
	Traced bool `json:"traced,omitempty"`
}

HTTPRequest is information about HTTP request.

type HTTPResponse 

type HTTPResponse struct {
	// number indicating the HTTP status of the response.
	Status int `json:"status,omitempty"`

	// number indicating the length of the response body in bytes.
	ContentLength int64 `json:"content_length,omitempty"`
}

HTTPResponse is information about HTTP response.

type LogReference added in v1.1.0 

type LogReference struct {
	// The log group name associated with the segment.
	LogGroup string `json:"log_group,omitempty"`

	// the ARN of the log group associated with this reference.
	ARN string `json:"arn,omitempty"`
}

LogReference represents a link between a trace segment and supporting CloudWatch logs.

type SQL 

type SQL struct {
	// For SQL Server or other database connections that don't use URL connection strings, record the connection string, excluding passwords.
	ConnectionString string `json:"connection_string,omitempty"`

	// For a database connection that uses a URL connection string, record the URL, excluding passwords.
	URL string `json:"url,omitempty"`

	// The database query, with any user provided values removed or replaced by a placeholder.
	SanitizedQuery string `json:"sanitized_query,omitempty"`

	// The name of the database engine.
	DatabaseType string `json:"database_type,omitempty"`

	// The version number of the database engine.
	DatabaseVersion string `json:"database_version,omitempty"`

	// The name and version number of the database engine driver that your application uses.
	DriverVersion string `json:"driver_version,omitempty"`

	// The database username.
	User string `json:"user,omitempty"`

	// "call" if the query used a PreparedCall; "statement" if the query used a PreparedStatement.
	Preparation string `json:"preparation,omitempty"`
}

SQL is information for queries that your application makes to an SQL database.

type Segment 

type Segment struct {

	// The logical name of the service that handled the request, up to 200 characters.
	// For example, your application's name or domain name.
	Name string `json:"name"`

	// ID is a 64-bit identifier for the segment,
	// unique among segments in the same trace, in 16 hexadecimal digits.
	ID string `json:"id"`

	// TraceID is a unique identifier that connects all segments and subsegments originating
	// from a single client request. Trace ID Format.
	TraceID string `json:"trace_id,omitempty"`

	// StartTime is a number that is the time the segment was created,
	// in floating point seconds in epoch time.
	StartTime float64 `json:"start_time"`

	// EndTime is a number that is the time the segment was closed.
	EndTime float64 `json:"end_time,omitempty"`

	// InProgress is a boolean, set to true instead of specifying an end_time to record that a segment is started, but is not complete.
	InProgress bool `json:"in_progress,omitempty"`

	// An object with information about your application.
	Service *Service `json:"service,omitempty"`

	// A string that identifies the user who sent the request.
	User string `json:"user,omitempty"`

	// The type of AWS resource running your application.
	Origin string `json:"origin,omitempty"`

	// A subsegment ID you specify if the request originated from an instrumented application.
	ParentID string `json:"parent_id,omitempty"`

	// subsegment. Required only if sending a subsegment separately.
	Type string `json:"type,omitempty"`

	// aws for AWS SDK calls; remote for other downstream calls.
	Namespace string `json:"namespace,omitempty"`

	// http objects with information about the original HTTP request.
	HTTP *HTTP `json:"http,omitempty"`

	// aws object with information about the AWS resource on which your application served the request.
	AWS AWS `json:"aws,omitempty"`

	// SQL is information for queries that your application makes to an SQL database.
	SQL *SQL `json:"sql,omitempty"`

	// boolean indicating that a client error occurred (response status code was 4XX Client Error).
	Error bool `json:"error,omitempty"`

	// boolean indicating that a request was throttled (response status code was 429 Too Many Requests).
	Throttle bool `json:"throttle,omitempty"`

	// boolean indicating that a server error occurred (response status code was 5XX Server Error).
	Fault bool `json:"fault,omitempty"`

	// Indicate the cause of the error by including a cause object in the segment or subsegment.
	Cause *Cause `json:"cause,omitempty"`

	// annotations object with key-value pairs that you want X-Ray to index for search.
	Annotations map[string]any `json:"annotations,omitempty"`

	// metadata object with any additional data that you want to store in the segment.
	Metadata map[string]any `json:"metadata,omitempty"`

	// array of subsegment objects.
	Subsegments []*Segment `json:"subsegments,omitempty"`

	// array of subsegment IDs that identifies subsegments with the same parent that completed prior to this subsegment.
	PrecursorIDs []string `json:"precursor_ids,omitempty"`
}

Segment is a segment.

type Service 

type Service struct {
	// Version is a string that identifies the version of your application that served the request.
	Version string `json:"version,omitempty"`

	RuntimeVersion string `json:"runtime_version,omitempty"`
	Runtime        string `json:"runtime,omitempty"`

	// Compiler and CompilerVersion will be removed.
	// They are defined only to keep backward compatibility.
	// https://github.com/shogo82148/aws-xray-yasdk-go/pull/105
	Compiler        string `json:"-"`
	CompilerVersion string `json:"-"`
}

Service is information about your application.

type StackFrame 

type StackFrame struct {
	// The relative path to the file.
	Path string `json:"path,omitempty"`

	// The line in the file.
	Line int `json:"line,omitempty"`

	// The function or method name.
	Label string `json:"label,omitempty"`
}

StackFrame is stack frame.

type XRay 

type XRay struct {
	SDKVersion       string `json:"sdk_version,omitempty"`
	SDK              string `json:"sdk,omitempty"`
	SamplingRuleName string `json:"sampling_rule_name,omitempty"`
}

XRay is information about X-Ray SDK.

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.