microsoft/gctoolkit

Public

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

CodeCommitsIssuesPull requestsActionsInsightsSecurity
313a0660604daee70dc5014cc3cfae357cb731fd

Branches

Tags

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

Clone

HTTPS

Download ZIP

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

61lines · modeblame

3ce8e8bbKirk Pepperdine4 years ago1// Copyright (c) Microsoft Corporation.
2// Licensed under the MIT License.
3
e74e68d3Kirk Pepperdine3 years ago4import com.microsoft.gctoolkit.jvm.PreUnifiedJavaVirtualMachine;
5import com.microsoft.gctoolkit.jvm.UnifiedJavaVirtualMachine;
6
2531a724Kirk Pepperdine3 years ago7/*
38a277aeDavid Grieve4 years ago8* Contains the core API for the Microsoft, Java Garbage Collection Toolkit.
9* The toolkit is a GC log parser and a framework for consuming and extracting data from
10* GC log events.
11* <p>
12* The main entry points are:
13* <dl>
279969cckabutz4 years ago14* <dt>{@link com.microsoft.gctoolkit.GCToolKit}</dt>
38a277aeDavid Grieve4 years ago15* <dd>This is the main API that an application will use.</dd>
279969cckabutz4 years ago16* <dt>{@link com.microsoft.gctoolkit.io.GCLogFile}</dt>
5509b357Kirk Pepperdine4 years ago17* <dd>A GCLogFile is passed to GCToolKit for analysis.</dd>
279969cckabutz4 years ago18* <dt>{@link com.microsoft.gctoolkit.jvm.JavaVirtualMachine}</dt>
38a277aeDavid Grieve4 years ago19* <dd>This contains the results from running an analysis on a GC log.</dd>
279969cckabutz4 years ago20* <dt>{@link com.microsoft.gctoolkit.event.jvm.JVMEvent}</dt>
38a277aeDavid Grieve4 years ago21* <dd>The parser generates JVMEvents.</dd>
279969cckabutz4 years ago22* <dt>{@link com.microsoft.gctoolkit.aggregator.Aggregator}</dt>
38a277aeDavid Grieve4 years ago23* <dd>An Aggregator captures JVMEvents for analysis.</dd>
279969cckabutz4 years ago24* <dt>{@link com.microsoft.gctoolkit.aggregator.Aggregation}</dt>
38a277aeDavid Grieve4 years ago25* <dd>An Aggregation works with an Aggregator to collect and analyze data from JVMEvents.</dd>
26* </dl>
2531a724Kirk Pepperdine3 years ago27*/
28/**
279969cckabutz4 years ago29* @uses com.microsoft.gctoolkit.jvm.JavaVirtualMachine
30* @uses com.microsoft.gctoolkit.aggregator.Aggregator
3ce8e8bbKirk Pepperdine4 years ago31*/
8b6201adChristian Stein4 years ago32module com.microsoft.gctoolkit.api {
d96119e6kabutz4 years ago33requires java.logging;
3ce8e8bbKirk Pepperdine4 years ago34
5509b357Kirk Pepperdine4 years ago35exports com.microsoft.gctoolkit;
36exports com.microsoft.gctoolkit.aggregator;
37exports com.microsoft.gctoolkit.event;
38exports com.microsoft.gctoolkit.event.g1gc;
39exports com.microsoft.gctoolkit.event.generational;
40exports com.microsoft.gctoolkit.event.jvm;
41exports com.microsoft.gctoolkit.event.shenandoah;
42exports com.microsoft.gctoolkit.event.zgc;
43exports com.microsoft.gctoolkit.io;
44exports com.microsoft.gctoolkit.jvm;
45exports com.microsoft.gctoolkit.time;
e74e68d3Kirk Pepperdine3 years ago46exports com.microsoft.gctoolkit.message;
3ce8e8bbKirk Pepperdine4 years ago47
279969cckabutz4 years ago48uses com.microsoft.gctoolkit.aggregator.Aggregation;
d96119e6kabutz4 years ago49uses com.microsoft.gctoolkit.jvm.JavaVirtualMachine;
49a86dfbKirk Pepperdine4 years ago50uses com.microsoft.gctoolkit.jvm.Diarizer;
e74e68d3Kirk Pepperdine3 years ago51uses com.microsoft.gctoolkit.message.DataSourceParser;
52uses com.microsoft.gctoolkit.message.DataSourceChannel;
53uses com.microsoft.gctoolkit.message.DataSourceChannelListener;
54uses com.microsoft.gctoolkit.message.JVMEventChannel;
55uses com.microsoft.gctoolkit.message.JVMEventChannelListener;
56
57// todo: no need to load with SPI
58provides com.microsoft.gctoolkit.jvm.JavaVirtualMachine with
59PreUnifiedJavaVirtualMachine,
60UnifiedJavaVirtualMachine;
3ce8e8bbKirk Pepperdine4 years ago61}