-
Notifications
You must be signed in to change notification settings - Fork 448
Expand file tree
/
Copy pathmain.dox
More file actions
54 lines (39 loc) · 2.16 KB
/
main.dox
File metadata and controls
54 lines (39 loc) · 2.16 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
/*!
@mainpage Cloud Trace API C++ Client Library
An idiomatic C++ client library for the [Cloud Trace API][cloud-service-docs],
a service to send application trace data to Cloud Trace for viewing. This
library is used to interact with the Trace API directly. If you are looking to
instrument your application for Cloud Trace, we recommend using
[OpenTelemetry](https://opentelemetry.io) or a similar framework.
While this library is **GA**, please note Google Cloud C++ client libraries do **not** follow [Semantic Versioning](https://semver.org/).
@tableofcontents{HTML:2}
## Quickstart
The following shows the code that you'll run in the
`google/cloud/trace/quickstart/` directory,
which should give you a taste of the Cloud Trace API C++ client library API.
@snippet quickstart.cc all
## Main classes
<!-- inject-client-list-start -->
This library offers multiple `*Client` classes, which are listed below. Each one
of these classes exposes all the RPCs for a service as member functions of the
class. This library groups multiple services because they are part of the same
product or are often used together. A typical example may be the administrative
and data plane operations for a single product.
The library also has other classes that provide helpers, configuration
parameters, and infrastructure to mock the `*Client` classes when testing your
application.
- [\c trace_v1::TraceServiceClient](@ref google::cloud::trace_v1::TraceServiceClient)
- [\c trace_v2::TraceServiceClient](@ref google::cloud::trace_v2::TraceServiceClient)
<!-- inject-client-list-end -->
## More Information
- @ref common-error-handling - describes how the library reports errors.
- @ref trace-override-endpoint - describes how to override the default
endpoint.
- @ref trace-override-authentication - describes how to change the
authentication credentials used by the library.
- @ref trace-override-retry - describes how to change the default retry
policies.
- @ref trace-env - describes environment variables that can configure the behavior of the library.
- @ref trace-override-universe-domain - describes how to override the default universe domain.
[cloud-service-docs]: https://cloud.google.com/trace
*/