Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Attach description to the URLs #3135

Merged
merged 1 commit into from
Apr 4, 2024
Merged

Attach description to the URLs #3135

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
30 changes: 15 additions & 15 deletions docs/modules/ROOT/pages/http-client.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -349,23 +349,23 @@ The following table provides information for the HTTP client metrics:
|=======
| metric name | type | description
| reactor.netty.http.client.data.received | DistributionSummary | Amount of the data received, in bytes.
See xref:observability.adoc#observability-metrics-data-received[]
See xref:observability.adoc#observability-metrics-data-received[Data Received]
| reactor.netty.http.client.data.sent | DistributionSummary | Amount of the data sent, in bytes.
See xref:observability.adoc#observability-metrics-data-sent[]
See xref:observability.adoc#observability-metrics-data-sent[Data Sent]
| reactor.netty.http.client.errors | Counter | Number of errors that occurred.
See xref:observability.adoc#observability-metrics-errors-count[]
See xref:observability.adoc#observability-metrics-errors-count[Errors Count]
| reactor.netty.http.client.tls.handshake.time | Timer | Time spent for TLS handshake.
See xref:observability.adoc#observability-metrics-tls-handshake-time[]
See xref:observability.adoc#observability-metrics-tls-handshake-time[Tls Handshake Time]
| reactor.netty.http.client.connect.time | Timer | Time spent for connecting to the remote address.
See xref:observability.adoc#observability-metrics-connect-time[]
See xref:observability.adoc#observability-metrics-connect-time[Connect Time]
| reactor.netty.http.client.address.resolver | Timer | Time spent for resolving the address.
See xref:observability.adoc#observability-metrics-hostname-resolution-time[]
See xref:observability.adoc#observability-metrics-hostname-resolution-time[Hostname Resolution Time]
| reactor.netty.http.client.data.received.time | Timer | Time spent in consuming incoming data.
See xref:observability.adoc#observability-metrics-http-client-data-received-time[]
See xref:observability.adoc#observability-metrics-http-client-data-received-time[Http Client Data Received Time]
| reactor.netty.http.client.data.sent.time | Timer | Time spent in sending outgoing data.
See xref:observability.adoc#observability-metrics-http-client-data-sent-time[]
See xref:observability.adoc#observability-metrics-http-client-data-sent-time[Http Client Data Sent Time]
| reactor.netty.http.client.response.time | Timer | Total time for the request/response
See xref:observability.adoc#observability-metrics-http-client-response-time[]
See xref:observability.adoc#observability-metrics-http-client-response-time[Http Client Response Time]
|=======

These additional metrics are also available:
Expand All @@ -378,9 +378,9 @@ The following table provides information for the HTTP client metrics when it is
|=======
| metric name | type | description
| reactor.netty.connection.provider.active.streams | Gauge | The number of the active HTTP/2 streams.
See xref:observability.adoc#observability-metrics-active-streams[]
See xref:observability.adoc#observability-metrics-active-streams[Active Streams]
| reactor.netty.connection.provider.pending.streams | Gauge | The number of requests that are waiting for opening HTTP/2 stream.
See xref:observability.adoc#observability-metrics-pending-streams[]
See xref:observability.adoc#observability-metrics-pending-streams[Pending Streams]
|=======

include::partial$alloc-metrics.adoc[]
Expand Down Expand Up @@ -424,13 +424,13 @@ The following table provides information for the HTTP client spans:
|=======
| contextual name | description
| HTTP <HTTP METHOD> | Information and total time for the request.
See xref:observability.adoc#observability-spans-http-client-response-span[].
See xref:observability.adoc#observability-spans-http-client-response-span[Http Client Response Span].
| hostname resolution | Information and time spent for resolving the address.
See xref:observability.adoc#observability-spans-hostname-resolution-span[].
See xref:observability.adoc#observability-spans-hostname-resolution-span[Hostname Resolution Span].
| connect | Information and time spent for connecting to the remote address.
See xref:observability.adoc#observability-spans-connect-span[].
See xref:observability.adoc#observability-spans-connect-span[Connect Span].
| tls handshake | Information and time spent for TLS handshake.
See xref:observability.adoc#observability-spans-tls-handshake-span[].
See xref:observability.adoc#observability-spans-tls-handshake-span[Tls Handshake Span].
|=======

The following example enables that integration. This concrete example uses `Brave` and reports the information to `Zipkin`.
Expand Down
20 changes: 10 additions & 10 deletions docs/modules/ROOT/pages/http-server.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -515,23 +515,23 @@ The following table provides information for the HTTP server metrics:
|=======
| metric name | type | description
| reactor.netty.http.server.streams.active | Gauge | The number of active HTTP/2 streams.
See xref:observability.adoc#observability-metrics-streams-active[]
See xref:observability.adoc#observability-metrics-streams-active[Streams Active]
| reactor.netty.http.server.connections.active | Gauge | The number of http connections currently processing requests.
See xref:observability.adoc#observability-metrics-connections-active[]
See xref:observability.adoc#observability-metrics-connections-active[Connections Active]
| reactor.netty.http.server.connections.total | Gauge | The number of all opened connections.
See xref:observability.adoc#observability-metrics-connections-total[]
See xref:observability.adoc#observability-metrics-connections-total[Connections Total]
| reactor.netty.http.server.data.received | DistributionSummary | Amount of the data received, in bytes.
See xref:observability.adoc#observability-metrics-data-received[]
See xref:observability.adoc#observability-metrics-data-received[Data Received]
| reactor.netty.http.server.data.sent | DistributionSummary | Amount of the data sent, in bytes.
See xref:observability.adoc#observability-metrics-data-sent[]
See xref:observability.adoc#observability-metrics-data-sent[Data Sent]
| reactor.netty.http.server.errors | Counter | Number of errors that occurred.
See xref:observability.adoc#observability-metrics-errors-count[]
See xref:observability.adoc#observability-metrics-errors-count[Errors Count]
| reactor.netty.http.server.data.received.time | Timer | Time spent in consuming incoming data.
See xref:observability.adoc#observability-metrics-http-server-data-received-time[]
See xref:observability.adoc#observability-metrics-http-server-data-received-time[Http Server Data Received Time]
| reactor.netty.http.server.data.sent.time | Timer | Time spent in sending outgoing data.
See xref:observability.adoc#observability-metrics-http-server-data-sent-time[]
See xref:observability.adoc#observability-metrics-http-server-data-sent-time[Http Server Data Sent Time]
| reactor.netty.http.server.response.time | Timer | Total time for the request/response
See xref:observability.adoc#observability-metrics-http-server-response-time[]
See xref:observability.adoc#observability-metrics-http-server-response-time[Http Server Response Time]
|=======

These additional metrics are also available:
Expand Down Expand Up @@ -574,7 +574,7 @@ The following table provides information for the HTTP server spans:
|=======
| contextual name | description
| <HTTP METHOD>_<URI> | Information and total time for the request.
See xref:observability.adoc#observability-spans-http-server-response-span[].
See xref:observability.adoc#observability-spans-http-server-response-span[Http Server Response Span].
|=======

The following example enables that integration. This concrete example uses `Brave` and reports the information to `Zipkin`.
Expand Down
18 changes: 9 additions & 9 deletions docs/modules/ROOT/pages/tcp-client.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -239,17 +239,17 @@ The following table provides information for the TCP client metrics:
|=======
| metric name | type | description
| reactor.netty.tcp.client.data.received | DistributionSummary | Amount of the data received, in bytes.
See xref:observability.adoc#observability-metrics-data-received[]
See xref:observability.adoc#observability-metrics-data-received[Data Received]
| reactor.netty.tcp.client.data.sent | DistributionSummary | Amount of the data sent, in bytes.
See xref:observability.adoc#observability-metrics-data-sent[]
See xref:observability.adoc#observability-metrics-data-sent[Data Sent]
| reactor.netty.tcp.client.errors | Counter | Number of errors that occurred.
See xref:observability.adoc#observability-metrics-errors-count[]
See xref:observability.adoc#observability-metrics-errors-count[Errors Count]
| reactor.netty.tcp.client.tls.handshake.time | Timer | Time spent for TLS handshake.
See xref:observability.adoc#observability-metrics-tls-handshake-time[]
See xref:observability.adoc#observability-metrics-tls-handshake-time[Tls Handshake Time]
| reactor.netty.tcp.client.connect.time | Timer | Time spent for connecting to the remote address.
See xref:observability.adoc#observability-metrics-connect-time[]
See xref:observability.adoc#observability-metrics-connect-time[Connect Time]
| reactor.netty.tcp.client.address.resolver | Timer | Time spent for resolving the address.
See xref:observability.adoc#observability-metrics-hostname-resolution-time[]
See xref:observability.adoc#observability-metrics-hostname-resolution-time[Hostname Resolution Time]
|=======

These additional metrics are also available:
Expand Down Expand Up @@ -288,11 +288,11 @@ The following table provides information for the TCP client spans:
|=======
| contextual name | description
| hostname resolution | Information and time spent for resolving the address.
See xref:observability.adoc#observability-spans-hostname-resolution-span[].
See xref:observability.adoc#observability-spans-hostname-resolution-span[Hostname Resolution Span].
| connect | Information and time spent for connecting to the remote address.
See xref:observability.adoc#observability-spans-connect-span[].
See xref:observability.adoc#observability-spans-connect-span[Connect Span].
| tls handshake | Information and time spent for TLS handshake.
See xref:observability.adoc#observability-spans-tls-handshake-span[].
See xref:observability.adoc#observability-spans-tls-handshake-span[Tls Handshake Span].
|=======

The following example enables that integration. This concrete example uses `Brave` and reports the information to `Zipkin`.
Expand Down
12 changes: 6 additions & 6 deletions docs/modules/ROOT/pages/tcp-server.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -216,15 +216,15 @@ The following table provides information for the TCP server metrics:
|=======
| metric name | type | description
| reactor.netty.tcp.server.connections.total | Gauge | The number of all opened connections.
See xref:observability.adoc#observability-metrics-connections-total[]
See xref:observability.adoc#observability-metrics-connections-total[Connections Total]
| reactor.netty.tcp.server.data.received | DistributionSummary | Amount of the data received, in bytes.
See xref:observability.adoc#observability-metrics-data-received[]
See xref:observability.adoc#observability-metrics-data-received[Data Received]
| reactor.netty.tcp.server.data.sent | DistributionSummary | Amount of the data sent, in bytes.
See xref:observability.adoc#observability-metrics-data-sent[]
See xref:observability.adoc#observability-metrics-data-sent[Data Sent]
| reactor.netty.tcp.server.errors | Counter | Number of errors that occurred.
See xref:observability.adoc#observability-metrics-errors-count[]
See xref:observability.adoc#observability-metrics-errors-count[Errors Count]
| reactor.netty.tcp.server.tls.handshake.time | Timer | Time spent for TLS handshake.
See xref:observability.adoc#observability-metrics-tls-handshake-time[]
See xref:observability.adoc#observability-metrics-tls-handshake-time[Tls Handshake Time]
|=======

These additional metrics are also available:
Expand Down Expand Up @@ -261,7 +261,7 @@ The following table provides information for the TCP server spans:
|=======
| contextual name | description
| tls handshake | Information and time spent for TLS handshake.
See xref:observability.adoc#observability-spans-tls-handshake-span[].
See xref:observability.adoc#observability-spans-tls-handshake-span[Tls Handshake Span].
|=======

The following example enables that integration. This concrete example uses `Brave` and reports the information to `Zipkin`.
Expand Down
10 changes: 5 additions & 5 deletions docs/modules/ROOT/pages/udp-client.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -177,15 +177,15 @@ The following table provides information for the UDP client metrics:
|=======
| metric name | type | description
| reactor.netty.udp.client.data.received | DistributionSummary | Amount of the data received, in bytes.
See xref:observability.adoc#observability-metrics-data-received[]
See xref:observability.adoc#observability-metrics-data-received[Data Received]
| reactor.netty.udp.client.data.sent | DistributionSummary | Amount of the data sent, in bytes.
See xref:observability.adoc#observability-metrics-data-sent[]
See xref:observability.adoc#observability-metrics-data-sent[Data Sent]
| reactor.netty.udp.client.errors | Counter | Number of errors that occurred.
See xref:observability.adoc#observability-metrics-errors-count[]
See xref:observability.adoc#observability-metrics-errors-count[Errors Count]
| reactor.netty.udp.client.connect.time | Timer | Time spent for connecting to the remote address.
See xref:observability.adoc#observability-metrics-connect-time[]
See xref:observability.adoc#observability-metrics-connect-time[Connect Time]
| reactor.netty.udp.client.address.resolver | Timer | Time spent for resolving the address.
See xref:observability.adoc#observability-metrics-hostname-resolution-time[]
See xref:observability.adoc#observability-metrics-hostname-resolution-time[Hostname Resolution Time]
|=======

These additional metrics are also available:
Expand Down
10 changes: 5 additions & 5 deletions docs/modules/ROOT/pages/udp-server.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -125,8 +125,8 @@ include::{examples-dir}/lifecycle/Application.java[lines=18..39]
This section describes three kinds of configuration that you can use at the UDP level:

* xref:udp-server.adoc#server-udp-connection-configurations-channel-options[Channel Options]
* xref:udp-server.adoc#server-udp-connection-configurations-wire-logger[null]
* xref:udp-server.adoc#server-udp-connection-configurations-event-loop-group[null]
* xref:udp-server.adoc#server-udp-connection-configurations-wire-logger[Wire Logger]
* xref:udp-server.adoc#server-udp-connection-configurations-event-loop-group[Event Loop Group]

[[server-udp-connection-configurations-channel-options]]
=== Channel Options
Expand Down Expand Up @@ -171,11 +171,11 @@ The following table provides information for the UDP server metrics:
|=======
| metric name | type | description
| reactor.netty.udp.server.data.received | DistributionSummary | Amount of the data received, in bytes.
See xref:observability.adoc#observability-metrics-data-received[]
See xref:observability.adoc#observability-metrics-data-received[Data Received]
| reactor.netty.udp.server.data.sent | DistributionSummary | Amount of the data sent, in bytes.
See xref:observability.adoc#observability-metrics-data-sent[]
See xref:observability.adoc#observability-metrics-data-sent[Data Sent]
| reactor.netty.udp.server.errors | Counter | Number of errors that occurred.
See xref:observability.adoc#observability-metrics-errors-count[]
See xref:observability.adoc#observability-metrics-errors-count[Errors Count]
|=======

These additional metrics are also available:
Expand Down
20 changes: 10 additions & 10 deletions docs/modules/ROOT/partials/alloc-metrics.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,23 +4,23 @@
|=======
| metric name | type | description
| reactor.netty.bytebuf.allocator.used.heap.memory | Gauge | The number of bytes reserved by heap buffer allocator.
See xref:observability.adoc#observability-metrics-used-heap-memory[]
See xref:observability.adoc#observability-metrics-used-heap-memory[Used Heap Memory]
| reactor.netty.bytebuf.allocator.used.direct.memory | Gauge | The number of bytes reserved by direct buffer allocator.
See xref:observability.adoc#observability-metrics-used-direct-memory[]
See xref:observability.adoc#observability-metrics-used-direct-memory[Used Direct Memory]
| reactor.netty.bytebuf.allocator.heap.arenas | Gauge | The number of heap arenas (when `PooledByteBufAllocator`).
See xref:observability.adoc#observability-metrics-heap-arenas[]
See xref:observability.adoc#observability-metrics-heap-arenas[Heap Arenas]
| reactor.netty.bytebuf.allocator.direct.arenas | Gauge | The number of direct arenas (when `PooledByteBufAllocator`).
See xref:observability.adoc#observability-metrics-direct-arenas[]
See xref:observability.adoc#observability-metrics-direct-arenas[Direct Arenas]
| reactor.netty.bytebuf.allocator.threadlocal.caches | Gauge | The number of thread local caches (when `PooledByteBufAllocator`).
See xref:observability.adoc#observability-metrics-thread-local-caches[]
See xref:observability.adoc#observability-metrics-thread-local-caches[Thread Local Caches]
| reactor.netty.bytebuf.allocator.small.cache.size | Gauge | The size of the small cache (when `PooledByteBufAllocator`).
See xref:observability.adoc#observability-metrics-small-cache-size[]
See xref:observability.adoc#observability-metrics-small-cache-size[Small Cache Size]
| reactor.netty.bytebuf.allocator.normal.cache.size | Gauge | The size of the normal cache (when `PooledByteBufAllocator`).
See xref:observability.adoc#observability-metrics-normal-cache-size[]
See xref:observability.adoc#observability-metrics-normal-cache-size[Normal Cache Size]
| reactor.netty.bytebuf.allocator.chunk.size | Gauge | The chunk size for an arena (when `PooledByteBufAllocator`).
See xref:observability.adoc#observability-metrics-chunk-size[]
See xref:observability.adoc#observability-metrics-chunk-size[Chunk Size]
| reactor.netty.bytebuf.allocator.active.heap.memory | Gauge | The actual bytes consumed by in-use buffers allocated from heap buffer pools (when `PooledByteBufAllocator`).
See xref:observability.adoc#observability-metrics-active-heap-memory[]
See xref:observability.adoc#observability-metrics-active-heap-memory[Active Heap Memory]
| reactor.netty.bytebuf.allocator.active.direct.memory | Gauge | The actual bytes consumed by in-use buffers allocated from direct buffer pools (when `PooledByteBufAllocator`).
See xref:observability.adoc#observability-metrics-active-direct-memory[]
See xref:observability.adoc#observability-metrics-active-direct-memory[Active Direct Memory]
|=======
14 changes: 7 additions & 7 deletions docs/modules/ROOT/partials/conn-provider-metrics.adoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,17 +4,17 @@ Pooled `ConnectionProvider` metrics
|=======
| metric name | type | description
| reactor.netty.connection.provider.total.connections | Gauge | The number of all connections, active or idle.
See xref:observability.adoc#observability-metrics-total-connections[]
See xref:observability.adoc#observability-metrics-total-connections[Total Connections]
| reactor.netty.connection.provider.active.connections | Gauge | The number of the connections that have been successfully acquired and are in active use.
See xref:observability.adoc#observability-metrics-active-connections[]
See xref:observability.adoc#observability-metrics-active-connections[Active Connections]
| reactor.netty.connection.provider.max.connections | Gauge | The maximum number of active connections that are allowed.
See xref:observability.adoc#observability-metrics-max-connections[]
See xref:observability.adoc#observability-metrics-max-connections[Max Connections]
| reactor.netty.connection.provider.idle.connections | Gauge | The number of the idle connections.
See xref:observability.adoc#observability-metrics-idle-connections[]
See xref:observability.adoc#observability-metrics-idle-connections[Idle Connections]
| reactor.netty.connection.provider.pending.connections | Gauge | The number of requests that are waiting for a connection.
See xref:observability.adoc#observability-metrics-pending-connections[]
See xref:observability.adoc#observability-metrics-pending-connections[Pending Connections]
| reactor.netty.connection.provider.pending.connections.time | Timer | Time spent in pending acquire a connection from the connection pool.
See xref:observability.adoc#observability-metrics-pending-connections-time[]
See xref:observability.adoc#observability-metrics-pending-connections-time[Pending Connections Time]
| reactor.netty.connection.provider.max.pending.connections | Gauge | The maximum number of requests that will be queued while waiting for a ready connection.
See xref:observability.adoc#observability-metrics-max-pending-connections[]
See xref:observability.adoc#observability-metrics-max-pending-connections[Max Pending Connections]
|=======
Loading
Loading