README
¶
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.
- Ask a question in the AWS X-Ray Forum.
- Open a support ticket with AWS Support.
- If you think you may have found a bug, open an issue.
- For contributing guidelines refer CONTRIBUTING.md.
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/...
You can also use Glide to manage dependencies by using:
glide install
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]
- -a --resource-arn Amazon Resource Name (ARN) of the AWS resource running the daemon.
- -o --local-mode Don't check for EC2 instance metadata.
- -m --buffer-memory Change the amount of memory in MB that buffers can use (minimum 3).
- -n --region Send segments to X-Ray service in a specific region.
- -b --bind Overrides default UDP address (127.0.0.1:2000).
- -t --bind-tcp Overrides default TCP address (127.0.0.1:2000).
- -r --role-arn Assume the specified IAM role to upload segments to a different account.
- -c --config Load a configuration file from the specified path.
- -f --log-file Output logs to the specified file path.
- -l --log-level Log level, from most verbose to least: dev, debug, info, warn, error, prod (default).
- -p --proxy-address Proxy address through which to upload segments.
- -v --version Show AWS X-Ray daemon version.
- -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.
Testing
make test will run unit tests for the X-Ray daemon.
License
This library is licensed under the Apache 2.0 License.
Directories