microsoft/gctoolkit

Public

mirrored from https://github.com/microsoft/gctoolkitAvailable

CodeCommitsIssuesPull requestsActionsInsightsSecurity
ac75bbcf909df4378e493b466d7bed06ef9032d8

Branches

Tags

  • No tags available.
0Branches0Tags
Go to file
Add file
Code

Clone

HTTPS

Download ZIP

api/src/main/java/module-info.java

46lines · modeblame

3ce8e8bbKirk Pepperdine4 years ago1// Copyright (c) Microsoft Corporation.
2// Licensed under the MIT License.
3
4/**
38a277aeDavid Grieve4 years ago5* Contains the core API for the Microsoft, Java Garbage Collection Toolkit.
6* The toolkit is a GC log parser and a framework for consuming and extracting data from
7* GC log events.
8* <p>
9* The main entry points are:
10* <dl>
279969cckabutz4 years ago11* <dt>{@link com.microsoft.gctoolkit.GCToolKit}</dt>
38a277aeDavid Grieve4 years ago12* <dd>This is the main API that an application will use.</dd>
279969cckabutz4 years ago13* <dt>{@link com.microsoft.gctoolkit.io.GCLogFile}</dt>
5509b357Kirk Pepperdine4 years ago14* <dd>A GCLogFile is passed to GCToolKit for analysis.</dd>
279969cckabutz4 years ago15* <dt>{@link com.microsoft.gctoolkit.jvm.JavaVirtualMachine}</dt>
38a277aeDavid Grieve4 years ago16* <dd>This contains the results from running an analysis on a GC log.</dd>
279969cckabutz4 years ago17* <dt>{@link com.microsoft.gctoolkit.event.jvm.JVMEvent}</dt>
38a277aeDavid Grieve4 years ago18* <dd>The parser generates JVMEvents.</dd>
279969cckabutz4 years ago19* <dt>{@link com.microsoft.gctoolkit.aggregator.Aggregator}</dt>
38a277aeDavid Grieve4 years ago20* <dd>An Aggregator captures JVMEvents for analysis.</dd>
279969cckabutz4 years ago21* <dt>{@link com.microsoft.gctoolkit.aggregator.Aggregation}</dt>
38a277aeDavid Grieve4 years ago22* <dd>An Aggregation works with an Aggregator to collect and analyze data from JVMEvents.</dd>
23* </dl>
279969cckabutz4 years ago24*
25* @uses com.microsoft.gctoolkit.jvm.JavaVirtualMachine
26* @uses com.microsoft.gctoolkit.aggregator.Aggregator
3ce8e8bbKirk Pepperdine4 years ago27*/
8b6201adChristian Stein4 years ago28module com.microsoft.gctoolkit.api {
d96119e6kabutz4 years ago29requires java.logging;
3ce8e8bbKirk Pepperdine4 years ago30
5509b357Kirk Pepperdine4 years ago31exports com.microsoft.gctoolkit;
32exports com.microsoft.gctoolkit.aggregator;
33exports com.microsoft.gctoolkit.event;
34exports com.microsoft.gctoolkit.event.g1gc;
35exports com.microsoft.gctoolkit.event.generational;
36exports com.microsoft.gctoolkit.event.jvm;
37exports com.microsoft.gctoolkit.event.shenandoah;
38exports com.microsoft.gctoolkit.event.zgc;
39exports com.microsoft.gctoolkit.io;
40exports com.microsoft.gctoolkit.jvm;
41exports com.microsoft.gctoolkit.time;
3ce8e8bbKirk Pepperdine4 years ago42
279969cckabutz4 years ago43uses com.microsoft.gctoolkit.aggregator.Aggregation;
d96119e6kabutz4 years ago44uses com.microsoft.gctoolkit.jvm.JavaVirtualMachine;
49a86dfbKirk Pepperdine4 years ago45uses com.microsoft.gctoolkit.jvm.Diarizer;
3ce8e8bbKirk Pepperdine4 years ago46}