Skip to content

Latest commit

 

History

History
99 lines (71 loc) · 4.81 KB

README.md

File metadata and controls

99 lines (71 loc) · 4.81 KB
Raw

Google Cloud Java Client for Stackdriver Trace

Java idiomatic client for Stackdriver Trace.

Build Status Coverage Status Maven Codacy Badge Dependency Status

Note: This client is a work-in-progress, and may occasionally make backwards-incompatible changes.

Quickstart

If you are using Maven, add this to your pom.xml file

<dependency>
  <groupId>com.google.cloud</groupId>
  <artifactId>google-cloud-trace</artifactId>
  <version>0.30.0-beta</version>
</dependency>

If you are using Gradle, add this to your dependencies

compile 'com.google.cloud:google-cloud-trace:0.30.0-beta'

If you are using SBT, add this to your dependencies

libraryDependencies += "com.google.cloud" % "google-cloud-trace" % "0.30.0-beta"

Authentication

See the Authentication section in the base directory's README.

About Stackdriver Trace

Stackdriver Trace is a distributed tracing system that collects latency data from your applications and displays it in the Google Cloud Platform Console. You can track how requests propagate through your application and receive detailed near real-time performance insights.

See the Trace client library docs to learn how to use this client library.

Getting Started

Prerequisites

You will need a Google Developers Console project with the Stackdriver Trace API enabled. Follow these instructions to get your project set up. You will also need to set up the local development environment by installing the Google Cloud SDK and running the following commands in command line: gcloud auth login and gcloud config set project [YOUR PROJECT ID].

Installation and setup

You'll need to obtain the google-cloud-trace library. See the Quickstart section to add google-cloud-trace as a dependency in your code.

Troubleshooting

To get help, follow the instructions in the shared Troubleshooting document.

Transport

Trace uses gRPC for the transport layer.

Java Versions

Java 7 or above is required for using this client.

Versioning

This library follows Semantic Versioning.

It is currently in major version zero (0.y.z), which means that anything may change at any time and the public API should not be considered stable.

Contributing

Contributions to this library are always welcome and highly encouraged.

See google-cloud's CONTRIBUTING documentation and the shared documentation for more information on how to get started.

Please note that this project is released with a Contributor Code of Conduct. By participating in this project you agree to abide by its terms. See Code of Conduct for more information.

License

Apache 2.0 - See LICENSE for more information.