|
| 1 | +# ======================================= # |
| 2 | +# Kamon-Http4s Reference Configuration # |
| 3 | +# ======================================= # |
| 4 | + |
| 5 | +kamon.instrumentation.http4s { |
| 6 | + |
| 7 | + # Settings to control the HTTP Server instrumentation. |
| 8 | + # |
| 9 | + # IMPORTANT: Besides the "initial-operation-name" and "unhandled-operation-name" settings, the entire configuration of |
| 10 | + # the HTTP Server Instrumentation is based on the constructs provided by the Kamon Instrumentation Common library |
| 11 | + # which will always fallback to the settings found under the "kamon.instrumentation.http-server.default" path. The |
| 12 | + # default settings have been included here to make them easy to find and understand in the context of this project and |
| 13 | + # commented out so that any changes to the default settings will actually have effect. |
| 14 | + # |
| 15 | + server { |
| 16 | + |
| 17 | + # |
| 18 | + # Configuration for HTTP context propagation. |
| 19 | + # |
| 20 | + propagation { |
| 21 | + |
| 22 | + # Enables or disables HTTP context propagation on this HTTP server instrumentation. Please note that if |
| 23 | + # propagation is disabled then some distributed tracing features will not be work as expected (e.g. Spans can |
| 24 | + # be created and reported but will not be linked across boundaries nor take trace identifiers from tags). |
| 25 | + #enabled = yes |
| 26 | + |
| 27 | + # HTTP propagation channel to b used by this instrumentation. Take a look at the kamon.propagation.http.default |
| 28 | + # configuration for more details on how to configure the detault HTTP context propagation. |
| 29 | + channel = "default" |
| 30 | + |
| 31 | + |
| 32 | + } |
| 33 | + |
| 34 | + |
| 35 | + # |
| 36 | + # Configuration for HTTP server metrics collection. |
| 37 | + # |
| 38 | + metrics { |
| 39 | + |
| 40 | + # Enables collection of HTTP server metrics. When enabled the following metrics will be collected, assuming |
| 41 | + # that the instrumentation is fully compliant: |
| 42 | + # |
| 43 | + # - http.server.requets |
| 44 | + # - http.server.request.active |
| 45 | + # - http.server.request.size |
| 46 | + # - http.server.response.size |
| 47 | + # - http.server.connection.lifetime |
| 48 | + # - http.server.connection.usage |
| 49 | + # - http.server.connection.open |
| 50 | + # |
| 51 | + # All metrics have at least three tags: component, interface and port. Additionally, the http.server.requests |
| 52 | + # metric will also have a status_code tag with the status code group (1xx, 2xx and so on). |
| 53 | + # |
| 54 | + #enabled = yes |
| 55 | + } |
| 56 | + |
| 57 | + |
| 58 | + # |
| 59 | + # Configuration for HTTP request tracing. |
| 60 | + # |
| 61 | + tracing { |
| 62 | + |
| 63 | + # Enables HTTP request tracing. When enabled the instrumentation will create Spans for incoming requests |
| 64 | + # and finish them when the response is sent back to the clients. |
| 65 | + #enabled = yes |
| 66 | + |
| 67 | + # Select a context tag that provides a preferred trace identifier. The preferred trace identifier will be used |
| 68 | + # only if all these conditions are met: |
| 69 | + # - the context tag is present. |
| 70 | + # - there is no parent Span on the incoming context (i.e. this is the first service on the trace). |
| 71 | + # - the identifier is valid in accordance to the identity provider. |
| 72 | + #preferred-trace-id-tag = "none" |
| 73 | + |
| 74 | + # Enables collection of span metrics using the `span.processing-time` metric. |
| 75 | + #span-metrics = on |
| 76 | + |
| 77 | + # Select which tags should be included as span and span metric tags. The possible options are: |
| 78 | + # - span: the tag is added as a Span tag (i.e. using span.tag(...)) |
| 79 | + # - metric: the tag is added a a Span metric tag (i.e. using span.tagMetric(...)) |
| 80 | + # - off: the tag is not used. |
| 81 | + # |
| 82 | + tags { |
| 83 | + |
| 84 | + # Use the http.url tag. |
| 85 | + #url = span |
| 86 | + |
| 87 | + # Use the http.method tag. |
| 88 | + #method = metric |
| 89 | + |
| 90 | + # Use the http.status_code tag. |
| 91 | + #status-code = metric |
| 92 | + |
| 93 | + # Copy tags from the context into the Spans with the specified purpouse. For example, to copy a customer_type |
| 94 | + # tag from the context into the HTTP Server Span created by the instrumentation, the following configuration |
| 95 | + # should be added: |
| 96 | + # |
| 97 | + # from-context { |
| 98 | + # customer_type = span |
| 99 | + # } |
| 100 | + # |
| 101 | + from-context { |
| 102 | + |
| 103 | + } |
| 104 | + } |
| 105 | + |
| 106 | + # Controls writing trace and span identifiers to HTTP response headers sent by the instrumented servers. The |
| 107 | + # configuration can be set to either "none" to disable writing the identifiers on the response headers or to |
| 108 | + # the header name to be used when writing the identifiers. |
| 109 | + response-headers { |
| 110 | + |
| 111 | + # HTTP response header name for the trace identifier, or "none" to disable it. |
| 112 | + #trace-id = "trace-id" |
| 113 | + |
| 114 | + # HTTP response header name for the server span identifier, or "none" to disable it. |
| 115 | + #span-id = none |
| 116 | + } |
| 117 | + |
| 118 | + # Custom mappings between routes and operation names. |
| 119 | + operations { |
| 120 | + |
| 121 | + # The default operation name to be used when creating Spans to handle the HTTP server requests. In most |
| 122 | + # cases it is not possible to define an operation name right at the moment of starting the HTTP server Span |
| 123 | + # and in those cases, this operation name will be initially assigned to the Span. Instrumentation authors |
| 124 | + # should do their best effort to provide a suitable operation name or make use of the "mappings" facilities. |
| 125 | + default = "http.server.request" |
| 126 | + |
| 127 | + # The operation name to be assigned when an application cannot find any route/endpoint/controller to handle |
| 128 | + # a given request. Depending on the instrumented framework, it might be possible to apply this operation |
| 129 | + # name automatically or not, check the frameworks' instrumentation docs for more details. |
| 130 | + unhandled = "unhandled" |
| 131 | + |
| 132 | + # FQCN for a HttpOperationNameGenerator implementation, or ony of the following shorthand forms: |
| 133 | + # - default: Uses the set default operation name |
| 134 | + # - method: Uses the request HTTP method as the operation name. |
| 135 | + # |
| 136 | + name-generator = "kamon.http4s.PathOperationNameGenerator" |
| 137 | + |
| 138 | + # Provides custom mappings from HTTP paths into operation names. Meant to be used in cases where the bytecode |
| 139 | + # instrumentation is not able to provide a sensible operation name that is free of high cardinality values. |
| 140 | + # For example, with the following configuration: |
| 141 | + # mappings { |
| 142 | + # "/organization/*/user/*/profile" = "/organization/:orgID/user/:userID/profile" |
| 143 | + # "/events/*/rsvps" = "EventRSVPs" |
| 144 | + # } |
| 145 | + # |
| 146 | + # Requests to "/organization/3651/user/39652/profile" and "/organization/22234/user/54543/profile" will have |
| 147 | + # the same operation name "/organization/:orgID/user/:userID/profile". |
| 148 | + # |
| 149 | + # Similarly, requests to "/events/aaa-bb-ccc/rsvps" and "/events/1234/rsvps" will have the same operation |
| 150 | + # name "EventRSVPs". |
| 151 | + # |
| 152 | + # The patterns are expressed as globs and the operation names are free form. |
| 153 | + # |
| 154 | + mappings { |
| 155 | + |
| 156 | + } |
| 157 | + } |
| 158 | + } |
| 159 | + } |
| 160 | + |
| 161 | + # Settings to control the HTTP Client instrumentation |
| 162 | + # |
| 163 | + # IMPORTANT: The entire configuration of the HTTP Client Instrumentation is based on the constructs provided by the |
| 164 | + # Kamon Instrumentation Common library which will always fallback to the settings found under the |
| 165 | + # "kamon.instrumentation.http-client.default" path. The default settings have been included here to make them easy to |
| 166 | + # find and understand in the context of this project and commented out so that any changes to the default settings |
| 167 | + # will actually have effect. |
| 168 | + # |
| 169 | + client { |
| 170 | + |
| 171 | + # |
| 172 | + # Configuration for HTTP context propagation. |
| 173 | + # |
| 174 | + propagation { |
| 175 | + |
| 176 | + # Enables or disables HTTP context propagation on this HTTP server instrumentation. Please note that if |
| 177 | + # propagation is disabled then some distributed tracing features will not be work as expected (e.g. Spans can |
| 178 | + # be created and reported but will not be linked across boundaries nor take trace identifiers from tags). |
| 179 | + #enabled = yes |
| 180 | + |
| 181 | + # HTTP propagation channel to be used by this instrumentation. Take a look at the kamon.propagation.http.default |
| 182 | + # configuration for more details on how to configure the detault HTTP context propagation. |
| 183 | + #channel = "default" |
| 184 | + } |
| 185 | + |
| 186 | + tracing { |
| 187 | + |
| 188 | + # Enables HTTP request tracing. When enabled the instrumentation will create Spans for outgoing requests |
| 189 | + # and finish them when the response is received from the server. |
| 190 | + #enabled = yes |
| 191 | + |
| 192 | + # Enables collection of span metrics using the `span.processing-time` metric. |
| 193 | + #span-metrics = on |
| 194 | + |
| 195 | + # Select which tags should be included as span and span metric tags. The possible options are: |
| 196 | + # - span: the tag is added as a Span tag (i.e. using span.tag(...)) |
| 197 | + # - metric: the tag is added a a Span metric tag (i.e. using span.tagMetric(...)) |
| 198 | + # - off: the tag is not used. |
| 199 | + # |
| 200 | + tags { |
| 201 | + |
| 202 | + # Use the http.url tag. |
| 203 | + #url = span |
| 204 | + |
| 205 | + # Use the http.method tag. |
| 206 | + #method = metric |
| 207 | + |
| 208 | + # Use the http.status_code tag. |
| 209 | + #status-code = metric |
| 210 | + |
| 211 | + # Copy tags from the context into the Spans with the specified purpouse. For example, to copy a customer_type |
| 212 | + # tag from the context into the HTTP Server Span created by the instrumentation, the following configuration |
| 213 | + # should be added: |
| 214 | + # |
| 215 | + # from-context { |
| 216 | + # customer_type = span |
| 217 | + # } |
| 218 | + # |
| 219 | + from-context { |
| 220 | + |
| 221 | + } |
| 222 | + } |
| 223 | + |
| 224 | + operations { |
| 225 | + |
| 226 | + # The default operation name to be used when creating Spans to handle the HTTP client requests. The HTTP |
| 227 | + # Client instrumentation will always try to use the HTTP Operation Name Generator configured bellow to get |
| 228 | + # a name, but if it fails to generate it then this name will be used. |
| 229 | + #default = "http.client.request" |
| 230 | + |
| 231 | + # FQCN for a HttpOperationNameGenerator implementation, or ony of the following shorthand forms: |
| 232 | + # - hostname: Uses the request Host as the operation name. |
| 233 | + # - method: Uses the request HTTP method as the operation name. |
| 234 | + # |
| 235 | + name-generator = "kamon.http4s.PathOperationNameGenerator" |
| 236 | + } |
| 237 | + } |
| 238 | + } |
| 239 | + |
| 240 | + |
| 241 | +} |
| 242 | + |
| 243 | + |
| 244 | +kanela.modules { |
| 245 | + http4s { |
| 246 | + name = "Http4s Instrumentation" |
| 247 | + description = "Provides context propagation, distributed tracing and HTTP client and server metrics for Http4s" |
| 248 | + |
| 249 | + instrumentations = [] |
| 250 | + |
| 251 | + within = [] |
| 252 | + } |
| 253 | +} |
| 254 | + |
0 commit comments