Skip to content

Commit f3d0bca

Browse files
authored
Update design doc for data provider changes (#15)
* Remove unused import * Update design doc
1 parent ae6aa89 commit f3d0bca

File tree

1 file changed

+7
-4
lines changed

1 file changed

+7
-4
lines changed

DESIGN.md

+7-4
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@ Application Metrics for Java™ is composed of:
88

99
## Components
1010
### Agent
11-
An Agent that stores data added via the API and emits data to receivers.
11+
`com.ibm.javametrics.agent` package implements an Agent that stores data added via the API and emits data to receivers.
1212

1313
### Javametrics API
1414
Javametrics provides a Java API to interface with the Agent. The interface in the `com.ibm.javametrics` package consists of:
@@ -17,12 +17,15 @@ Javametrics provides a Java API to interface with the Agent. The interface in th
1717
* `Topic` - API to send data to the agent for a named topic.
1818

1919
### Data Providers
20-
21-
#### MBean providers
22-
`com.ibm.javametrics.dataproviders.MBeanDataProvider` is initialized statically in `com.ibm.javametrics.Javametrics` class. It gathers data from the MBean providers every 2 seconds and sends the data to the agent using the Javametrics API. MBean providers in the `com.ibm.javametrics.dataproviders` package are:
20+
`com.ibm.javametrics.dataproviders.DataProviderManager` is instantiated by `com.ibm.javametrics.impl.JavametricsImpl`.
21+
It gathers data from the data providers every 2 seconds and sends the data to the agent using the Javametrics API.
22+
23+
Data providers in the `com.ibm.javametrics.dataproviders` package are:
2324
* `CPUDataProvider` - system and process cpu usage data
2425
* `GCDataProvider` - garbage collection statistics
2526
* `MemoryPoolDataProvider` - heap and native memory usage data
27+
* `EnvironmentDataProvider` - runtime environment data
28+
2629

2730
#### Instrumentation providers
2831
Bytecode Instrumentation is used to gather HTTP data. Servlet and JSP classes are instrumented with callbacks to track and time the requests. The callbacks use the Javametrics API to send the data to the agent.

0 commit comments

Comments
 (0)