|
16 | 16 | * OpenTelemetry provider for UCP connection pool metrics. |
17 | 17 | * <p> |
18 | 18 | * This provider converts Oracle UCP events into OpenTelemetry metrics |
19 | | - * following database client semantic conventions. Users must configure |
20 | | - * the OpenTelemetry SDK separately - this provider only generates |
21 | | - * metrics. |
| 19 | + * following database client semantic conventions. |
22 | 20 | * </p> |
23 | | - * |
24 | | - * <h2>Configuration</h2> |
25 | | - * <pre>{@code |
26 | | - * PoolDataSource pds = PoolDataSourceFactory.getPoolDataSource(); |
27 | | - * pds.setUCPEventListenerProvider("otel-ucp-listener"); |
28 | | - * }</pre> |
29 | | - * |
30 | | - * <h2>Generated Metrics</h2> |
31 | | - * |
32 | | - * <h3>Gauges (7)</h3> |
33 | | - * <ul> |
34 | | - * <li>{@code db.client.connections.used} - Currently in-use |
35 | | - * connections (state=used)</li> |
36 | | - * <li>{@code db.client.connections.idle} - Currently idle connections |
37 | | - * (state=idle)</li> |
38 | | - * <li>{@code db.client.connections.count} - Total connections |
39 | | - * (borrowed + idle)</li> |
40 | | - * <li>{@code db.client.connections.max} - Maximum pool size</li> |
41 | | - * <li>{@code db.client.connections.min} - Minimum pool size</li> |
42 | | - * <li>{@code db.client.connections.created} - Total connections |
43 | | - * created since pool inception</li> |
44 | | - * <li>{@code db.client.connections.closed} - Total connections closed |
45 | | - * since pool inception</li> |
46 | | - * </ul> |
47 | | - * |
48 | | - * <h3>Counters (14)</h3> |
49 | | - * <ul> |
50 | | - * <li>{@code db.client.connection.pool.created} - Pool creation |
51 | | - * events</li> |
52 | | - * <li>{@code db.client.connection.pool.starting} - Pool starting |
53 | | - * events</li> |
54 | | - * <li>{@code db.client.connection.pool.started} - Pool started |
55 | | - * events</li> |
56 | | - * <li>{@code db.client.connection.pool.stopped} - Pool stopped |
57 | | - * events</li> |
58 | | - * <li>{@code db.client.connection.pool.restarting} - Pool restarting |
59 | | - * events</li> |
60 | | - * <li>{@code db.client.connection.pool.restarted} - Pool restarted |
61 | | - * events</li> |
62 | | - * <li>{@code db.client.connection.pool.destroyed} - Pool destruction |
63 | | - * events</li> |
64 | | - * <li>{@code db.client.connection.created} - Connection creation |
65 | | - * events</li> |
66 | | - * <li>{@code db.client.connection.borrowed} - Connection borrow |
67 | | - * events</li> |
68 | | - * <li>{@code db.client.connection.returned} - Connection return |
69 | | - * events</li> |
70 | | - * <li>{@code db.client.connection.closed} - Connection close |
71 | | - * events</li> |
72 | | - * <li>{@code db.client.connection.pool.refreshed} - Pool refresh |
73 | | - * operations</li> |
74 | | - * <li>{@code db.client.connection.pool.recycled} - Pool recycle |
75 | | - * operations</li> |
76 | | - * <li>{@code db.client.connection.pool.purged} - Pool purge |
77 | | - * operations</li> |
78 | | - * </ul> |
79 | | - * |
80 | | - * <h3>Histograms (1)</h3> |
81 | | - * <ul> |
82 | | - * <li>{@code db.client.connections.wait_time} - Connection |
83 | | - * acquisition wait time (milliseconds)</li> |
84 | | - * </ul> |
85 | | - * |
86 | | - * <h2>Attributes</h2> |
87 | | - * <ul> |
88 | | - * <li>{@code pool.name} - Name of the connection pool</li> |
89 | | - * <li>{@code state} - Connection state (used/idle) for connection |
90 | | - * state gauges</li> |
91 | | - * </ul> |
92 | | - * |
93 | | - * <h2>Requirements</h2> |
94 | | - * <ul> |
95 | | - * <li>Java 11 or higher</li> |
96 | | - * <li>OpenTelemetry API 1.0+</li> |
97 | | - * <li>OpenTelemetry SDK must be configured separately by the |
98 | | - * user</li> |
99 | | - * </ul> |
100 | | - * |
101 | | - * @since 1.0 |
102 | 21 | */ |
103 | 22 | public final class OtelUCPEventListenerProvider |
104 | 23 | implements UCPEventListenerProvider { |
|
0 commit comments