Skip to content

Latest commit

 

History

History
90 lines (60 loc) · 4.17 KB

README.md

File metadata and controls

90 lines (60 loc) · 4.17 KB
Raw

Build Status

AWS X-Ray Daemon

The AWS X-Ray daemon is a software application that listens for traffic on UDP port 2000, gathers raw segment data, and relays it to the AWS X-Ray API.
The daemon works in conjunction with the AWS X-Ray SDKs and must be running so that data sent by the SDKs can reach the X-Ray service. For more information, see AWS X-Ray Daemon.

Getting Help

Use the following community resources for getting help with the AWS X-Ray Daemon. We use the GitHub issues for tracking bugs and feature requests.

Sending Segment Documents

The X-Ray SDK sends segment documents to the daemon to avoid making calls to AWS directly. You can send the segment/subsegment in JSON over UDP port 2000 to the X-Ray daemon, prepended by the daemon header : {"format": "json", "version": 1}\n

{"format": "json", "version": 1}\n{<serialized segment data>}

For more details refer : Link

Installing

The AWS X-Ray Daemon is compatible with Go 1.8 and later.

Install the daemon using the following command:

go get -u github.com/aws/aws-xray-daemon/...

Credential Configuration

The AWS X-Ray Daemon follows default credential resolution for the aws-sdk-go.

Follow the guidelines for the credential configuration.

Daemon Usage (command line args)

Usage: X-Ray [options]

  1. -a --resource-arn Amazon Resource Name (ARN) of the AWS resource running the daemon.
  2. -o --local-mode Don't check for EC2 instance metadata.
  3. -m --buffer-memory Change the amount of memory in MB that buffers can use (minimum 3).
  4. -n --region Send segments to X-Ray service in a specific region.
  5. -b --bind Overrides default UDP address (127.0.0.1:2000).
  6. -t --bind-tcp Overrides default TCP address (127.0.0.1:2000).
  7. -r --role-arn Assume the specified IAM role to upload segments to a different account.
  8. -c --config Load a configuration file from the specified path.
  9. -f --log-file Output logs to the specified file path.
  10. -l --log-level Log level, from most verbose to least: dev, debug, info, warn, error, prod (default).
  11. -p --proxy-address Proxy address through which to upload segments.
  12. -v --version Show AWS X-Ray daemon version.
  13. -h --help Show this screen

Build

make build would build binaries and .zip files in /build folder for Linux, MacOS, and Windows platforms.

Linux

make build-linux would build binaries and .zip files in /build folder for the Linux platform.

MAC

make build-mac would build binaries and .zip files in /build folder for the MacOS platform.

Windows

make build-windows would build binaries and .zip files in /build folder for the Windows platform.

Build for ARM achitecture

Currently, the make build script builds artifacts for AMD architecture. You can build the X-Ray Daemon for ARM by using the go build command and setting the GOARCH to arm64. To build the daemon binary on a linux ARM machine, you can use the following command:

GOOS=linux GOARCH=arm64 go build -ldflags "-s -w" -o xray cmd/tracing/daemon.go cmd/tracing/tracing.go

As of Aug 31, 2020, windows and darwin builds for ARM64 are not supported by go build.

Testing

make test will run unit tests for the X-Ray daemon.

License

This library is licensed under the Apache 2.0 License.