Skip to content

Commit

Permalink
fix: updated javadoc
Browse files Browse the repository at this point in the history
Signed-off-by: Matt Peterson <[email protected]>
  • Loading branch information
mattp-swirldslabs committed Aug 12, 2024
1 parent be5d345 commit d305d33
Show file tree
Hide file tree
Showing 2 changed files with 18 additions and 0 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -36,8 +36,11 @@ public class BlockNodeContextFactory {
private BlockNodeContextFactory() {}

/**
* Use the create method to build a singleton block node context to manage system-wide metrics.
*
* @return an instance of {@link BlockNodeContext} which holds {@link Configuration}, {@link
* Metrics} and {@link MetricsService} for the rest of the application to use.
* @throws IOException when the java libraries fail to read information from a configuration source.
*/
public static BlockNodeContext create() throws IOException {
final Configuration configuration = getConfiguration();
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -60,9 +60,24 @@ public class MetricsService {
/** An example counter. */
public final Counter exampleCounter;

/**
* Update the counter of live block items transiting via the live stream.
*/
public final Counter liveBlockItems;

/**
* Update the counter of blocks persisted to storage.
*/
public final Counter blocksPersisted;

/**
* Update the counter of single blocks retrieved from storage.
*/
public final Counter singleBlocksRetrieved;

/**
* Update the gauge of subscribers currently consuming to the live stream.
*/
public final LongGauge subscribers;

/**
Expand Down

0 comments on commit d305d33

Please sign in to comment.