Skip to content

Commit 23d5dd2

Browse files
committed
Added documentation for the collector module/library
Signed-off-by: dhoard <[email protected]>
1 parent 40cb352 commit 23d5dd2

File tree

1 file changed

+30
-0
lines changed

1 file changed

+30
-0
lines changed

docs/content/1.1.0/collector.md

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
---
2+
title: "Collector Module"
3+
weight: 6
4+
---
5+
6+
The `collector` module/library is currently published to Maven Central and used as a dependency for some projects.
7+
8+
# Support Statement
9+
10+
The `collector` module/library is designed to serve as an internal project library, and its functionality is specifically tailored for use within the scope of the JMX Exporter.
11+
12+
As such, it is important to note the following:
13+
14+
- This module is intended for internal use within the JMX Exporter.
15+
16+
17+
- It is not _designed_ for consumption as a standalone library or for external integration.
18+
19+
20+
- No Guaranteed API Contract
21+
- The module does not provide API documentation or formal API contracts. The package structure, class names, method names, and method signatures are subject to change without notice, based on evolving project needs.
22+
23+
- Backward Compatibility
24+
- There is no guarantee of backward compatibility. Updates to the module may introduce breaking changes to existing functionality.
25+
26+
### Support Scope
27+
28+
Support for the `collector` module/library is limited outside of the JMX Exporter.
29+
30+
Questions or issues should be addressed to the JMX Exporter maintainers.

0 commit comments

Comments
 (0)