aboutsummaryrefslogtreecommitdiffhomepage
path: root/vendor/go.opencensus.io/trace/doc.go
diff options
context:
space:
mode:
authorNathan Dench <ndenc2@gmail.com>2019-05-24 15:16:44 +1000
committerNathan Dench <ndenc2@gmail.com>2019-05-24 15:16:44 +1000
commit107c1cdb09c575aa2f61d97f48d8587eb6bada4c (patch)
treeca7d008643efc555c388baeaf1d986e0b6b3e28c /vendor/go.opencensus.io/trace/doc.go
parent844b5a68d8af4791755b8f0ad293cc99f5959183 (diff)
downloadterraform-provider-statuscake-107c1cdb09c575aa2f61d97f48d8587eb6bada4c.tar.gz
terraform-provider-statuscake-107c1cdb09c575aa2f61d97f48d8587eb6bada4c.tar.zst
terraform-provider-statuscake-107c1cdb09c575aa2f61d97f48d8587eb6bada4c.zip
Upgrade to 0.12
Diffstat (limited to 'vendor/go.opencensus.io/trace/doc.go')
-rw-r--r--vendor/go.opencensus.io/trace/doc.go53
1 files changed, 53 insertions, 0 deletions
diff --git a/vendor/go.opencensus.io/trace/doc.go b/vendor/go.opencensus.io/trace/doc.go
new file mode 100644
index 0000000..04b1ee4
--- /dev/null
+++ b/vendor/go.opencensus.io/trace/doc.go
@@ -0,0 +1,53 @@
1// Copyright 2017, OpenCensus Authors
2//
3// Licensed under the Apache License, Version 2.0 (the "License");
4// you may not use this file except in compliance with the License.
5// You may obtain a copy of the License at
6//
7// http://www.apache.org/licenses/LICENSE-2.0
8//
9// Unless required by applicable law or agreed to in writing, software
10// distributed under the License is distributed on an "AS IS" BASIS,
11// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12// See the License for the specific language governing permissions and
13// limitations under the License.
14
15/*
16Package trace contains support for OpenCensus distributed tracing.
17
18The following assumes a basic familiarity with OpenCensus concepts.
19See http://opencensus.io
20
21
22Exporting Traces
23
24To export collected tracing data, register at least one exporter. You can use
25one of the provided exporters or write your own.
26
27 trace.RegisterExporter(exporter)
28
29By default, traces will be sampled relatively rarely. To change the sampling
30frequency for your entire program, call ApplyConfig. Use a ProbabilitySampler
31to sample a subset of traces, or use AlwaysSample to collect a trace on every run:
32
33 trace.ApplyConfig(trace.Config{DefaultSampler: trace.AlwaysSample()})
34
35Be careful about using trace.AlwaysSample in a production application with
36significant traffic: a new trace will be started and exported for every request.
37
38Adding Spans to a Trace
39
40A trace consists of a tree of spans. In Go, the current span is carried in a
41context.Context.
42
43It is common to want to capture all the activity of a function call in a span. For
44this to work, the function must take a context.Context as a parameter. Add these two
45lines to the top of the function:
46
47 ctx, span := trace.StartSpan(ctx, "example.com/Run")
48 defer span.End()
49
50StartSpan will create a new top-level span if the context
51doesn't contain another span, otherwise it will create a child span.
52*/
53package trace // import "go.opencensus.io/trace"