Skip to content

Commit

Permalink
Added documentation for the collector module/library
Browse files Browse the repository at this point in the history
Signed-off-by: dhoard <[email protected]>
  • Loading branch information
dhoard committed Dec 7, 2024
1 parent 40cb352 commit 23d5dd2
Showing 1 changed file with 30 additions and 0 deletions.
30 changes: 30 additions & 0 deletions docs/content/1.1.0/collector.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
---
title: "Collector Module"
weight: 6
---

The `collector` module/library is currently published to Maven Central and used as a dependency for some projects.

# Support Statement

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.

As such, it is important to note the following:

- This module is intended for internal use within the JMX Exporter.


- It is not _designed_ for consumption as a standalone library or for external integration.


- No Guaranteed API Contract
- 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.

- Backward Compatibility
- There is no guarantee of backward compatibility. Updates to the module may introduce breaking changes to existing functionality.

### Support Scope

Support for the `collector` module/library is limited outside of the JMX Exporter.

Questions or issues should be addressed to the JMX Exporter maintainers.

0 comments on commit 23d5dd2

Please sign in to comment.