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
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
|
/*
* Copyright The OpenTelemetry Authors
* SPDX-License-Identifier: Apache-2.0
*/
/*
* DO NOT EDIT, this is an Auto-generated file from:
* buildscripts/semantic-convention/templates/registry/semantic_attributes-h.j2
*/
#pragma once
#include "opentelemetry/common/macros.h"
#include "opentelemetry/version.h"
OPENTELEMETRY_BEGIN_NAMESPACE
namespace semconv
{
namespace url
{
/**
The <a href="https://www.rfc-editor.org/rfc/rfc3986#section-3.5">URI fragment</a> component
*/
static constexpr const char *kUrlFragment = "url.fragment";
/**
Absolute URL describing a network resource according to <a
href="https://www.rfc-editor.org/rfc/rfc3986">RFC3986</a> <p> For network calls, URL usually has
@code scheme://host[:port][path][?query][#fragment] @endcode format, where the fragment is not
transmitted over HTTP, but if it is known, it SHOULD be included nevertheless. <p>
@code url.full @endcode MUST NOT contain credentials passed via URL in form of @code
https://username:[email protected]/ @endcode. In such case username and password SHOULD be
redacted and attribute's value SHOULD be @code https://REDACTED:[email protected]/
@endcode. <p>
@code url.full @endcode SHOULD capture the absolute URL when it is available (or can be
reconstructed). <p> Sensitive content provided in @code url.full @endcode SHOULD be scrubbed when
instrumentations can identify it. <p>
Query string values for the following keys SHOULD be redacted by default and replaced by the
value @code REDACTED @endcode:
<ul>
<li><a
href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/RESTAuthentication.html#RESTAuthenticationQueryStringAuth">@code
AWSAccessKeyId @endcode</a></li> <li><a
href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/RESTAuthentication.html#RESTAuthenticationQueryStringAuth">@code
Signature @endcode</a></li> <li><a
href="https://learn.microsoft.com/azure/storage/common/storage-sas-overview#sas-token">@code sig
@endcode</a></li> <li><a
href="https://cloud.google.com/storage/docs/access-control/signed-urls">@code X-Goog-Signature
@endcode</a></li>
</ul>
<p>
This list is subject to change over time.
<p>
Matching of query parameter keys against the sensitive list SHOULD be case-sensitive.
<p>
Instrumentation MAY provide a way to override this list via declarative configuration.
If so, it SHOULD use the @code sensitive_query_parameters @endcode property
(an array of case-sensitive strings with minimum items 0) under
@code .instrumentation/development.general.sanitization.url @endcode.
This list is a full override of the default sensitive query parameter keys,
it is not a list of keys in addition to the defaults.
<p>
When a query string value is redacted, the query string key SHOULD still be preserved, e.g.
@code https://www.example.com/path?color=blue&sig=REDACTED @endcode.
*/
static constexpr const char *kUrlFull = "url.full";
/**
The <a href="https://www.rfc-editor.org/rfc/rfc3986#section-3.3">URI path</a> component
<p>
Sensitive content provided in @code url.path @endcode SHOULD be scrubbed when instrumentations can
identify it.
*/
static constexpr const char *kUrlPath = "url.path";
/**
The <a href="https://www.rfc-editor.org/rfc/rfc3986#section-3.4">URI query</a> component
<p>
Sensitive content provided in @code url.query @endcode SHOULD be scrubbed when instrumentations
can identify it. <p>
Query string values for the following keys SHOULD be redacted by default and replaced by the value
@code REDACTED @endcode: <ul> <li><a
href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/RESTAuthentication.html#RESTAuthenticationQueryStringAuth">@code
AWSAccessKeyId @endcode</a></li> <li><a
href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/RESTAuthentication.html#RESTAuthenticationQueryStringAuth">@code
Signature @endcode</a></li> <li><a
href="https://learn.microsoft.com/azure/storage/common/storage-sas-overview#sas-token">@code sig
@endcode</a></li> <li><a
href="https://cloud.google.com/storage/docs/access-control/signed-urls">@code X-Goog-Signature
@endcode</a></li>
</ul>
<p>
This list is subject to change over time.
<p>
Matching of query parameter keys against the sensitive list SHOULD be case-sensitive.
<p>
Instrumentation MAY provide a way to override this list via declarative configuration.
If so, it SHOULD use the @code sensitive_query_parameters @endcode property
(an array of case-sensitive strings with minimum items 0) under
@code .instrumentation/development.general.sanitization.url @endcode.
This list is a full override of the default sensitive query parameter keys,
it is not a list of keys in addition to the defaults.
<p>
When a query string value is redacted, the query string key SHOULD still be preserved, e.g.
@code q=OpenTelemetry&sig=REDACTED @endcode.
*/
static constexpr const char *kUrlQuery = "url.query";
/**
The <a href="https://www.rfc-editor.org/rfc/rfc3986#section-3.1">URI scheme</a> component
identifying the used protocol.
*/
static constexpr const char *kUrlScheme = "url.scheme";
} // namespace url
} // namespace semconv
OPENTELEMETRY_END_NAMESPACE
|
