Skip to content

Commit 92ab7aa

Browse files
giortzisggiortzisg
committed
feat(go): refactor options page
1 parent 89d683b commit 92ab7aa

File tree

2 files changed

+239
-118
lines changed
  • docs/platforms/go/common/configuration
  • platform-includes/configuration/config-intro

2 files changed

+239
-118
lines changed

‎docs/platforms/go/common/configuration/options.mdx‎

Lines changed: 232 additions & 116 deletions
Original file line numberDiff line numberDiff line change
@@ -6,125 +6,241 @@ description: "Learn more about how the SDK can be configured via options. These
66

77
<PlatformContent includePath="configuration/config-intro" />
88

9+
## Core Options
10+
11+
Options that can be read from an environment variable (`SENTRY_DSN`, `SENTRY_ENVIRONMENT`, `SENTRY_RELEASE`) are read automatically.
12+
13+
<ConfigKey name="dsn">
14+
15+
The DSN tells the SDK where to send the events. If this value is not provided, the SDK will try to read it from the `SENTRY_DSN` environment variable. If that variable also does not exist, the SDK will just not send any events.
16+
17+
Learn more about [DSN utilization](/product/sentry-basics/dsn-explainer/#dsn-utilization).
18+
19+
</ConfigKey>
20+
21+
<ConfigKey name="debug">
22+
23+
If debug is enabled, the SDK will attempt to print out useful debugging information if something goes wrong while sending the event. The default is always `false`. It's generally not recommended to turn it on in production, though turning `debug` mode on will not cause any safety concerns.
24+
25+
</ConfigKey>
26+
27+
<ConfigKey name="release">
28+
29+
Sets the release. Some Sentry features are built around releases, and, thus, reporting events with a non-empty release improves the product experience. See [the releases documentation](/product/releases/).
30+
31+
If Release is not set, the SDK will try to derive a default value from environment variables or the Git repository in the working directory.
32+
33+
If you distribute a compiled binary, it is recommended to set the Release value explicitly at build time. As an example, you can use:
34+
935
```go
10-
// ClientOptions that configures a SDK Client
11-
type ClientOptions struct {
12-
// The DSN to use. If the DSN is not set, the client is effectively
13-
// disabled.
14-
Dsn string
15-
// In debug mode, the debug information is printed to stdout to help you
16-
// understand what Sentry is doing.
17-
Debug bool
18-
// Configures whether SDK should generate and attach stack traces to pure
19-
// capture message calls.
20-
AttachStacktrace bool
21-
// The sample rate for event submission in the range [0.0, 1.0]. By default,
22-
// all events are sent. Thus, as a historical special case, the sample rate
23-
// 0.0 is treated as if it was 1.0. To drop all events, set the DSN to the
24-
// empty string.
25-
SampleRate float64
26-
// Enable structured logging.
27-
EnableLogs bool
28-
// Enable performance tracing.
29-
EnableTracing bool
30-
// The sample rate for sampling traces in the range [0.0, 1.0].
31-
TracesSampleRate float64
32-
// Used to customize the sampling of traces, overrides TracesSampleRate.
33-
TracesSampler TracesSampler
34-
// The sample rate for profiling traces in the range [0.0, 1.0].
35-
// This is relative to TracesSampleRate - it is a ratio of profiled traces out of all sampled traces.
36-
ProfilesSampleRate float64
37-
// List of regexp strings that will be used to match against event's message
38-
// and if applicable, caught errors type and value.
39-
// If the match is found, then a whole event will be dropped.
40-
IgnoreErrors []string
41-
// List of regexp strings that will be used to match against a transaction's
42-
// name. If a match is found, then the transaction will be dropped.
43-
IgnoreTransactions []string
44-
// If this flag is enabled, certain personally identifiable information (PII) is added by active integrations.
45-
// By default, no such data is sent.
46-
SendDefaultPII bool
47-
// BeforeSend is called before error events are sent to Sentry.
48-
// Use it to mutate the event or return nil to discard the event.
49-
BeforeSend func(event *Event, hint *EventHint) *Event
50-
// BeforeSendTransaction is called before transaction events are sent to Sentry.
51-
// Use it to mutate the transaction or return nil to discard the transaction.
52-
BeforeSendTransaction func(event *Event, hint *EventHint) *Event
53-
// Before breadcrumb add callback.
54-
BeforeBreadcrumb func(breadcrumb *Breadcrumb, hint *BreadcrumbHint) *Breadcrumb
55-
// Integrations to be installed on the current Client, receives default
56-
// integrations.
57-
Integrations func([]Integration) []Integration
58-
// io.Writer implementation that should be used with the Debug mode.
59-
DebugWriter io.Writer
60-
// The transport to use. Defaults to HTTPTransport.
61-
Transport Transport
62-
// The server name to be reported.
63-
ServerName string
64-
// The release to be sent with events.
65-
//
66-
// Some Sentry features are built around releases, and, thus, reporting
67-
// events with a non-empty release improves the product experience. See
68-
// https://docs.sentry.io/product/releases/.
69-
//
70-
// If Release is not set, the SDK will try to derive a default value
71-
// from environment variables or the Git repository in the working
72-
// directory.
73-
//
74-
// If you distribute a compiled binary, it is recommended to set the
75-
// Release value explicitly at build time. As an example, you can use:
76-
//
77-
// go build -ldflags='-X main.release=VALUE'
78-
//
79-
// That will set the value of a predeclared variable 'release' in the
80-
// 'main' package to 'VALUE'. Then, use that variable when initializing
81-
// the SDK:
82-
//
83-
// sentry.Init(ClientOptions{Release: release})
84-
//
85-
// See https://golang.org/cmd/go/ and https://golang.org/cmd/link/ for
86-
// the official documentation of -ldflags and -X, respectively.
87-
Release string
88-
// The dist to be sent with events.
89-
Dist string
90-
// The environment to be sent with events.
91-
Environment string
92-
// Maximum number of breadcrumbs
93-
// when MaxBreadcrumbs is negative then ignore breadcrumbs.
94-
MaxBreadcrumbs int
95-
// Maximum number of spans.
96-
//
97-
// See https://develop.sentry.dev/sdk/data-model/envelopes/#size-limits for size limits
98-
// applied during event ingestion. Events that exceed these limits might get dropped.
99-
MaxSpans int
100-
// An optional pointer to http.Client that will be used with a default
101-
// HTTPTransport. Using your own client will make HTTPTransport, HTTPProxy,
102-
// HTTPSProxy and CaCerts options ignored.
103-
HTTPClient *http.Client
104-
// An optional pointer to http.Transport that will be used with a default
105-
// HTTPTransport. Using your own transport will make HTTPProxy, HTTPSProxy
106-
// and CaCerts options ignored.
107-
HTTPTransport http.RoundTripper
108-
// An optional HTTP proxy to use.
109-
// This will default to the HTTP_PROXY environment variable.
110-
HTTPProxy string
111-
// An optional HTTPS proxy to use.
112-
// This will default to the HTTPS_PROXY environment variable.
113-
// HTTPS_PROXY takes precedence over HTTP_PROXY for https requests.
114-
HTTPSProxy string
115-
// An optional set of SSL certificates to use.
116-
CaCerts *x509.CertPool
117-
// MaxErrorDepth is the maximum number of errors reported in a chain of errors.
118-
// This protects the SDK from an arbitrarily long chain of wrapped errors.
119-
//
120-
// An additional consideration is that arguably reporting a long chain of errors
121-
// is of little use when debugging production errors with Sentry. The Sentry UI
122-
// is not optimized for long chains either. The top-level error together with a
123-
// stack trace is often the most useful information.
124-
MaxErrorDepth int
125-
}
36+
go build -ldflags='-X main.release=VALUE'
37+
```
38+
39+
That will set the value of a predeclared variable 'release' in the 'main' package to 'VALUE'. Then, use that variable when initializing the SDK:
40+
41+
```go
42+
sentry.Init(ClientOptions{Release: release})
12643
```
12744

45+
See https://golang.org/cmd/go/ and https://golang.org/cmd/link/ for the official documentation of -ldflags and -X, respectively.
46+
47+
</ConfigKey>
48+
49+
<ConfigKey name="dist">
50+
51+
Sets the distribution of the application. Distributions are used to disambiguate build or deployment variants of the same release of an application. The dist has a max length of 64 characters.
52+
53+
</ConfigKey>
54+
55+
<ConfigKey name="environment">
56+
57+
Sets the environment. This string is freeform and not set by default. A release can be associated with more than one environment to separate them in the UI (think `staging` vs `prod` or similar).
58+
59+
By default, the SDK will try to read this value from the `SENTRY_ENVIRONMENT` environment variable.
60+
61+
</ConfigKey>
62+
63+
<ConfigKey name="sample-rate">
64+
65+
Configures the sample rate for error events, in the range of `0.0` to `1.0`. The default is `1.0`, which means that 100% of error events will be sent. If set to `0.1`, only 10% of error events will be sent. Events are picked randomly.
66+
67+
As a historical special case, the sample rate `0.0` is treated as if it was `1.0`. To drop all events, set the DSN to the empty string.
68+
69+
</ConfigKey>
70+
71+
<ConfigKey name="max-breadcrumbs">
72+
73+
This variable controls the total amount of breadcrumbs that should be captured. This defaults to `100`, but you can set this to any number. However, you should be aware that Sentry has a [maximum payload size](https://develop.sentry.dev/sdk/data-model/envelopes/#size-limits) and any events exceeding that payload size will be dropped.
74+
75+
When MaxBreadcrumbs is negative then breadcrumbs are ignored.
76+
77+
</ConfigKey>
78+
79+
<ConfigKey name="max-spans">
80+
81+
Maximum number of spans that can be attached to a transaction.
82+
83+
See https://develop.sentry.dev/sdk/data-model/envelopes/#size-limits for size limits applied during event ingestion. Events that exceed these limits might get dropped.
84+
85+
</ConfigKey>
86+
87+
<ConfigKey name="attach-stacktrace">
88+
89+
When enabled, stack traces are automatically attached to all messages logged. Stack traces are always attached to errors; however, when this option is set, stack traces are also sent with messages. This option, for instance, means that stack traces appear next to all log messages.
90+
91+
This option is turned off by default.
92+
93+
Grouping in Sentry is different for events with stack traces and without. As a result, you will get new groups as you enable or disable this flag for certain events.
94+
95+
</ConfigKey>
96+
97+
<ConfigKey name="send-default-pii">
98+
99+
If this flag is enabled, certain personally identifiable information (PII) is added by active integrations. By default, no such data is sent.
100+
101+
If you enable this option, be sure to manually remove what you don't want to send using our features for managing [_Sensitive Data_](../../data-management/sensitive-data/).
102+
103+
</ConfigKey>
104+
105+
<ConfigKey name="server-name">
106+
107+
This option can be used to supply a server name. When provided, the name of the server is sent along and persisted in the event. For many integrations, the server name actually corresponds to the device hostname, even in situations where the machine is not actually a server.
108+
109+
Most SDKs will attempt to auto-discover this value.
110+
111+
</ConfigKey>
112+
113+
<ConfigKey name="ignore-errors">
114+
115+
A list of regexp strings that will be used to match against event's message and if applicable, caught errors type and value. If the match is found, then a whole event will be dropped.
116+
117+
</ConfigKey>
118+
119+
<ConfigKey name="ignore-transactions">
120+
121+
A list of regexp strings that will be used to match against a transaction's name. If a match is found, then the transaction will be dropped.
122+
123+
</ConfigKey>
124+
125+
<ConfigKey name="max-error-depth">
126+
127+
This is the maximum number of errors reported in a chain of errors. This protects the SDK from an arbitrarily long chain of wrapped errors.
128+
129+
An additional consideration is that arguably reporting a long chain of errors is of little use when debugging production errors with Sentry. The Sentry UI is not optimized for long chains either. The top-level error together with a stack trace is often the most useful information.
130+
131+
</ConfigKey>
132+
133+
## Logging Options
134+
135+
<ConfigKey name="enable-logs">
136+
137+
Enable structured logging. When enabled, the SDK will capture log messages and send them to Sentry.
138+
139+
</ConfigKey>
140+
141+
## Tracing Options
142+
143+
<ConfigKey name="enable-tracing">
144+
145+
Enable performance tracing. When enabled, the SDK will create transactions and spans to measure performance.
146+
147+
</ConfigKey>
148+
149+
<ConfigKey name="traces-sample-rate">
150+
151+
A number between `0.0` and `1.0`, controlling the percentage chance a given transaction will be sent to Sentry (`0.0` represents 0% while `1.0` represents 100%.) Applies equally to all transactions created in the app.
152+
153+
</ConfigKey>
154+
155+
<ConfigKey name="traces-sampler">
156+
157+
Used to customize the sampling of traces, overrides TracesSampleRate. A function responsible for determining the percentage chance a given transaction will be sent to Sentry. It will automatically be passed information about the transaction and the context in which it's being created, and must return a number between `0` (0% chance of being sent) and `1` (100% chance of being sent). Can also be used for filtering transactions, by returning 0 for those that are unwanted.
158+
159+
</ConfigKey>
160+
161+
## Hooks
162+
163+
These options can be used to hook the SDK in various ways to customize the reporting of events.
164+
165+
<ConfigKey name="before-send">
166+
167+
This function is called with an SDK-specific message or error event object, and can return a modified event object, or `nil` to skip reporting the event. This can be used, for instance, for manual PII stripping before sending.
168+
169+
By the time `before-send` is executed, all scope data has already been applied to the event. Further modification of the scope won't have any effect.
170+
171+
</ConfigKey>
172+
173+
<ConfigKey name="before-send-transaction">
174+
175+
This function is called with an SDK-specific transaction event object, and can return a modified transaction event object, or `nil` to skip reporting the event. One way this might be used is for manual PII stripping before sending.
176+
177+
</ConfigKey>
178+
179+
<ConfigKey name="before-breadcrumb">
180+
181+
This function is called with an SDK-specific breadcrumb object before the breadcrumb is added to the scope. When `nil` is returned from the function, the breadcrumb is dropped. To pass the breadcrumb through, return the first argument, which contains the breadcrumb object.
182+
The callback typically gets a second argument (called a "hint") which contains the original object from which the breadcrumb was created to further customize what the breadcrumb should look like.
183+
184+
</ConfigKey>
185+
186+
## Integration Configuration
187+
188+
<ConfigKey name="integrations">
189+
190+
Integrations to be installed on the current Client, receives default integrations. For more information, please see our documentation for a specific integration.
191+
192+
</ConfigKey>
193+
194+
<ConfigKey name="debug-writer">
195+
196+
io.Writer implementation that should be used with the Debug mode.
197+
198+
</ConfigKey>
199+
200+
## Transport Options
201+
202+
Transports are used to send events to Sentry. Transports can be customized to some degree to better support highly specific deployments.
203+
204+
<ConfigKey name="transport">
205+
206+
The transport to use. Defaults to HTTPTransport. Switches out the transport used to send events. How this works depends on the SDK. It can, for instance, be used to capture events for unit-testing or to send it through some more complex setup that requires proxy authentication.
207+
208+
</ConfigKey>
209+
210+
<ConfigKey name="http-client">
211+
212+
An optional pointer to http.Client that will be used with a default HTTPTransport. Using your own client will make HTTPTransport, HTTPProxy, HTTPSProxy and CaCerts options ignored.
213+
214+
</ConfigKey>
215+
216+
<ConfigKey name="http-transport">
217+
218+
An optional pointer to http.Transport that will be used with a default HTTPTransport. Using your own transport will make HTTPProxy, HTTPSProxy and CaCerts options ignored.
219+
220+
</ConfigKey>
221+
222+
<ConfigKey name="http-proxy">
223+
224+
When set, a proxy can be configured that should be used for outbound requests. This is also used for HTTPS requests unless a separate `https-proxy` is configured. However, not all SDKs support a separate HTTPS proxy. SDKs will attempt to default to the system-wide configured proxy, if possible. For instance, on Unix systems, the `HTTP_PROXY` environment variable will be picked up.
225+
226+
This will default to the HTTP_PROXY environment variable.
227+
228+
</ConfigKey>
229+
230+
<ConfigKey name="https-proxy">
231+
232+
Configures a separate proxy for outgoing HTTPS requests. If this option is not provided but `http-proxy` is, then `http-proxy` is used for HTTPS requests too.
233+
234+
This will default to the HTTPS_PROXY environment variable. HTTPS_PROXY takes precedence over HTTP_PROXY for https requests.
235+
236+
</ConfigKey>
237+
238+
<ConfigKey name="ca-certs">
239+
240+
An optional set of SSL certificates to use.
241+
242+
</ConfigKey>
243+
128244
### Providing SSL Certificates
129245

130246
By default, TLS uses the host's root CA set. If you don't have `ca-certificates` (which should be your go-to way of fixing the issue of the missing certificates) and want to use `gocertifi` instead, you can provide pre-loaded cert files as one of the options to the `sentry.Init` call:

‎platform-includes/configuration/config-intro/go.mdx‎

Lines changed: 7 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,8 +3,13 @@ Options are passed to the `Init()` method as an instance of `sentry.ClientOption
33

44
```go
55
sentry.Init(sentry.ClientOptions{
6-
Dsn: "___PUBLIC_DSN___",
7-
Debug: true,
6+
Dsn: "___PUBLIC_DSN___",
7+
// Enable printing of SDK debug messages.
8+
// Useful when getting started or trying to figure something out.
9+
Debug: true,
10+
// Adds request headers and IP for users,
11+
// visit: https://docs.sentry.io/platforms/go/data-management/data-collected/ for more info
12+
SendDefaultPII: true,
813
// Release: "[email protected]",
914
})
1015
```

0 commit comments

Comments
 (0)