Index
All Classes and Interfaces|All Packages|Constant Field Values
A
- addFeature(Feature) - Method in class io.github.projectunified.faststats.core.Metrics.Builder
-
Adds a feature to be configured with the submit executor.
- addFeatures(Collection) - Method in class io.github.projectunified.faststats.core.Metrics.Builder
-
Adds a collection of features to be configured with the submit executor.
- addMetric(Metric) - Method in class io.github.projectunified.faststats.core.Metrics.Builder
-
Adds a metric to be collected and submitted.
- addMetrics(Collection) - Method in class io.github.projectunified.faststats.core.Metrics.Builder
-
Adds a collection of metrics to be collected and submitted.
- anonymize(String, String) - Method in class io.github.projectunified.faststats.errortracker.ErrorTracker
-
Adds an anonymization pattern replacement rule.
- anonymize(Pattern, String) - Method in class io.github.projectunified.faststats.errortracker.ErrorTracker
-
Adds an anonymization pattern replacement rule.
- array(String, Callable) - Static method in interface io.github.projectunified.faststats.core.Metric
-
Creates a new Array metric.
- attachErrorContext(ClassLoader) - Method in class io.github.projectunified.faststats.errortracker.ErrorTracker
-
Attaches uncaught error handling using the specified class loader.
B
- bool(String, Callable) - Static method in interface io.github.projectunified.faststats.core.Metric
-
Creates a new Boolean metric.
- build() - Method in class io.github.projectunified.faststats.core.Metrics.Builder
-
Builds the
Metricsinstance. - builder() - Static method in class io.github.projectunified.faststats.core.Metrics
-
Instantiates a new Builder.
- Builder() - Constructor for class io.github.projectunified.faststats.core.Metrics.Builder
- BukkitPlatform - Class in io.github.projectunified.faststats.bukkit
-
Bukkit implementation of
Platform. - BukkitPlatform(Plugin) - Constructor for class io.github.projectunified.faststats.bukkit.BukkitPlatform
-
Constructs a new
BukkitPlatformfor the given plugin. - BungeePlatform - Class in io.github.projectunified.faststats.bungeecord
-
BungeeCord implementation of
Platform. - BungeePlatform(Plugin) - Constructor for class io.github.projectunified.faststats.bungeecord.BungeePlatform
-
Constructs a new
BungeePlatformfor the given plugin.
C
- cancel() - Method in interface io.github.projectunified.faststats.core.TaskScheduler.Task
-
Cancels the scheduled task.
- collection(String, Callable) - Static method in interface io.github.projectunified.faststats.core.Metric
-
Creates a new Collection metric.
- Config - Interface in io.github.projectunified.faststats.core
-
Interface representing the configuration settings for metrics collection.
- contextAware() - Static method in class io.github.projectunified.faststats.errortracker.ErrorTracker
-
Creates a context-aware error tracker feature.
- contextUnaware() - Static method in class io.github.projectunified.faststats.errortracker.ErrorTracker
-
Creates a context-unaware error tracker feature.
D
- DEFAULT_COMMENT - Static variable in class io.github.projectunified.faststats.core.DefaultConfig
- DEFAULT_URL - Static variable in interface io.github.projectunified.faststats.core.Submitter
-
The default URL endpoint for metrics collection.
- DefaultConfig - Class in io.github.projectunified.faststats.core
-
Default implementation of
Configthat reads and writes configurations from a properties file. - DefaultConfig(Path, String[], boolean, Properties, boolean, UUID, boolean, boolean, boolean) - Constructor for class io.github.projectunified.faststats.core.DefaultConfig
-
Constructs a new
DefaultConfiginstance. - defaultScheduler() - Static method in interface io.github.projectunified.faststats.core.TaskScheduler
-
Creates a default single-threaded daemon executor-based scheduler.
- detachErrorContext() - Method in class io.github.projectunified.faststats.errortracker.ErrorTracker
-
Detaches error context handling and restores the original handler.
E
- ErrorTracker - Class in io.github.projectunified.faststats.errortracker
-
A feature that tracks uncaught and handled errors, anonymizes sensitive info, and submits report payloads.
- ErrorTracker() - Constructor for class io.github.projectunified.faststats.errortracker.ErrorTracker
-
Creates a new error tracker feature that is context-unaware.
- ErrorTracker(ClassLoader) - Constructor for class io.github.projectunified.faststats.errortracker.ErrorTracker
-
Creates a new error tracker feature with the specified class loader.
- execute(String) - Method in interface io.github.projectunified.faststats.core.Submitter
-
Executes the HTTP request carrying the serialized JSON payload.
- execute(String) - Method in class io.github.projectunified.faststats.httpclient.HttpClientSubmitter
- execute(String) - Method in class io.github.projectunified.faststats.net.NetSubmitter
F
- Feature - Class in io.github.projectunified.faststats.core
-
An abstract representation of a feature that can submit telemetry payloads on demand.
- Feature() - Constructor for class io.github.projectunified.faststats.core.Feature
G
- getConfig() - Method in class io.github.projectunified.faststats.bukkit.BukkitPlatform
- getConfig() - Method in class io.github.projectunified.faststats.bungeecord.BungeePlatform
- getConfig() - Method in class io.github.projectunified.faststats.core.Metrics
-
Gets the configuration settings.
- getConfig() - Method in interface io.github.projectunified.faststats.core.Platform
-
Retrieves the platform-specific configuration.
- getConfig() - Method in class io.github.projectunified.faststats.hytale.HytalePlatform
- getConfig() - Method in class io.github.projectunified.faststats.minestom.MinestomPlatform
- getConfig() - Method in class io.github.projectunified.faststats.nukkit.NukkitPlatform
- getConfig() - Method in class io.github.projectunified.faststats.sponge.SpongePlatform
- getConfig() - Method in class io.github.projectunified.faststats.velocity.VelocityPlatform
- getContextErrorHandler() - Method in class io.github.projectunified.faststats.errortracker.ErrorTracker
-
Gets the error event handler.
- getDefaultProperties() - Method in class io.github.projectunified.faststats.core.Feature
-
Gets the default properties to assign to the configuration.
- getDefaultProperties() - Method in class io.github.projectunified.faststats.errortracker.ErrorTracker
- getFeature(Class) - Method in class io.github.projectunified.faststats.core.Feature
-
Finds a registered feature of the specified class.
- getFeature(Class) - Method in class io.github.projectunified.faststats.core.Metrics
-
Finds a registered feature of the specified class.
- getMetrics() - Method in class io.github.projectunified.faststats.bukkit.BukkitPlatform
- getMetrics() - Method in class io.github.projectunified.faststats.bungeecord.BungeePlatform
- getMetrics() - Method in interface io.github.projectunified.faststats.core.Platform
-
Gets default platform-specific metrics.
- getMetrics() - Method in class io.github.projectunified.faststats.hytale.HytalePlatform
- getMetrics() - Method in class io.github.projectunified.faststats.minestom.MinestomPlatform
- getMetrics() - Method in class io.github.projectunified.faststats.nukkit.NukkitPlatform
- getMetrics() - Method in class io.github.projectunified.faststats.sponge.SpongePlatform
- getMetrics() - Method in class io.github.projectunified.faststats.velocity.VelocityPlatform
- getName() - Method in interface io.github.projectunified.faststats.core.Metric
-
Gets the unique name identifying this metric.
- getProperty(String, String) - Method in interface io.github.projectunified.faststats.core.Config
-
Gets a property value.
- getProperty(String, String) - Method in class io.github.projectunified.faststats.core.DefaultConfig
- getProperty(String, String) - Method in class io.github.projectunified.faststats.core.Feature
-
Gets a configuration property.
- getScheduler() - Method in class io.github.projectunified.faststats.core.Feature
-
Gets the TaskScheduler instance.
- getServerId() - Method in interface io.github.projectunified.faststats.core.Config
-
Retrieves the unique identifier of the server.
- getServerId() - Method in class io.github.projectunified.faststats.core.DefaultConfig
- getValue() - Method in interface io.github.projectunified.faststats.core.Metric
-
Retrieves the current value of the metric.
- GsonSerializer - Class in io.github.projectunified.faststats.gson
-
An implementation of
Serializerthat uses Google Gson. - GsonSerializer() - Constructor for class io.github.projectunified.faststats.gson.GsonSerializer
-
Constructs a new
GsonSerializerwith a defaultGsoninstance. - GsonSerializer(Gson) - Constructor for class io.github.projectunified.faststats.gson.GsonSerializer
-
Constructs a new
GsonSerializerwith the specifiedGsoninstance.
H
- HttpClientSubmitter - Class in io.github.projectunified.faststats.httpclient
-
Implementation of
Submitterthat usesHttpClientto submit GZIP-compressed telemetry payloads. - HttpClientSubmitter(String) - Constructor for class io.github.projectunified.faststats.httpclient.HttpClientSubmitter
-
Constructs a new
HttpClientSubmitterwith the default metrics URI (https://metrics.faststats.dev/v1/collect), standardHttpClient, and default user agent. - HttpClientSubmitter(HttpClient, URI, String, String) - Constructor for class io.github.projectunified.faststats.httpclient.HttpClientSubmitter
-
Constructs a new
HttpClientSubmitter. - HttpClientSubmitter(URI, String) - Constructor for class io.github.projectunified.faststats.httpclient.HttpClientSubmitter
-
Constructs a new
HttpClientSubmitterwith standardHttpClientand default user agent. - HytalePlatform - Class in io.github.projectunified.faststats.hytale
-
Hytale implementation of
Platform. - HytalePlatform(JavaPlugin) - Constructor for class io.github.projectunified.faststats.hytale.HytalePlatform
-
Constructs a new
HytalePlatformfor the given plugin.
I
- ignoreError(Class) - Method in class io.github.projectunified.faststats.errortracker.ErrorTracker
-
Adds an error type that will not be reported.
- ignoreError(Class, String) - Method in class io.github.projectunified.faststats.errortracker.ErrorTracker
-
Adds an error type and message pattern string that will be ignored.
- ignoreError(Class, Pattern) - Method in class io.github.projectunified.faststats.errortracker.ErrorTracker
-
Adds an error type and message pattern that will be ignored.
- ignoreError(String) - Method in class io.github.projectunified.faststats.errortracker.ErrorTracker
-
Adds a pattern string that will be matched against error messages to ignore them.
- ignoreError(Pattern) - Method in class io.github.projectunified.faststats.errortracker.ErrorTracker
-
Adds a pattern that will be matched against error messages to ignore them.
- io.github.projectunified.faststats.bukkit - package io.github.projectunified.faststats.bukkit
- io.github.projectunified.faststats.bungeecord - package io.github.projectunified.faststats.bungeecord
- io.github.projectunified.faststats.core - package io.github.projectunified.faststats.core
- io.github.projectunified.faststats.errortracker - package io.github.projectunified.faststats.errortracker
- io.github.projectunified.faststats.gson - package io.github.projectunified.faststats.gson
- io.github.projectunified.faststats.httpclient - package io.github.projectunified.faststats.httpclient
- io.github.projectunified.faststats.hytale - package io.github.projectunified.faststats.hytale
- io.github.projectunified.faststats.minestom - package io.github.projectunified.faststats.minestom
- io.github.projectunified.faststats.net - package io.github.projectunified.faststats.net
- io.github.projectunified.faststats.nukkit - package io.github.projectunified.faststats.nukkit
- io.github.projectunified.faststats.paper - package io.github.projectunified.faststats.paper
- io.github.projectunified.faststats.sponge - package io.github.projectunified.faststats.sponge
- io.github.projectunified.faststats.velocity - package io.github.projectunified.faststats.velocity
- isContextAttached() - Method in class io.github.projectunified.faststats.errortracker.ErrorTracker
-
Gets whether an error context is currently attached.
- isDebug() - Method in interface io.github.projectunified.faststats.core.Config
-
Checks if debug logging is enabled.
- isDebug() - Method in class io.github.projectunified.faststats.core.DefaultConfig
- isEnabled() - Method in interface io.github.projectunified.faststats.core.Config
-
Checks if metrics submission is enabled.
- isEnabled() - Method in class io.github.projectunified.faststats.core.DefaultConfig
- isFirstRun() - Method in interface io.github.projectunified.faststats.core.Config
-
Checks if this is the first time the metrics are running.
- isFirstRun() - Method in class io.github.projectunified.faststats.core.DefaultConfig
- isSubmitAdditionalMetrics() - Method in interface io.github.projectunified.faststats.core.Config
-
Checks if additional/custom metrics are enabled for submission.
- isSubmitAdditionalMetrics() - Method in class io.github.projectunified.faststats.core.DefaultConfig
L
- logError(String, Throwable) - Method in class io.github.projectunified.faststats.bukkit.BukkitPlatform
- logError(String, Throwable) - Method in class io.github.projectunified.faststats.bungeecord.BungeePlatform
- logError(String, Throwable) - Method in interface io.github.projectunified.faststats.core.Platform
-
Logs error messages.
- logError(String, Throwable) - Method in class io.github.projectunified.faststats.hytale.HytalePlatform
- logError(String, Throwable) - Method in class io.github.projectunified.faststats.minestom.MinestomPlatform
- logError(String, Throwable) - Method in class io.github.projectunified.faststats.nukkit.NukkitPlatform
- logError(String, Throwable) - Method in class io.github.projectunified.faststats.sponge.SpongePlatform
- logError(String, Throwable) - Method in class io.github.projectunified.faststats.velocity.VelocityPlatform
- logInfo(String) - Method in class io.github.projectunified.faststats.bukkit.BukkitPlatform
- logInfo(String) - Method in class io.github.projectunified.faststats.bungeecord.BungeePlatform
- logInfo(String) - Method in interface io.github.projectunified.faststats.core.Platform
-
Logs informational messages.
- logInfo(String) - Method in class io.github.projectunified.faststats.hytale.HytalePlatform
- logInfo(String) - Method in class io.github.projectunified.faststats.minestom.MinestomPlatform
- logInfo(String) - Method in class io.github.projectunified.faststats.nukkit.NukkitPlatform
- logInfo(String) - Method in class io.github.projectunified.faststats.sponge.SpongePlatform
- logInfo(String) - Method in class io.github.projectunified.faststats.velocity.VelocityPlatform
- logWarning(String) - Method in class io.github.projectunified.faststats.bukkit.BukkitPlatform
- logWarning(String) - Method in class io.github.projectunified.faststats.bungeecord.BungeePlatform
- logWarning(String) - Method in interface io.github.projectunified.faststats.core.Platform
-
Logs warning messages.
- logWarning(String) - Method in class io.github.projectunified.faststats.hytale.HytalePlatform
- logWarning(String) - Method in class io.github.projectunified.faststats.minestom.MinestomPlatform
- logWarning(String) - Method in class io.github.projectunified.faststats.nukkit.NukkitPlatform
- logWarning(String) - Method in class io.github.projectunified.faststats.sponge.SpongePlatform
- logWarning(String) - Method in class io.github.projectunified.faststats.velocity.VelocityPlatform
M
- map(String, Callable) - Static method in interface io.github.projectunified.faststats.core.Metric
-
Creates a new Map metric.
- Metric<T> - Interface in io.github.projectunified.faststats.core
-
Represents a single telemetry data source.
- Metrics - Class in io.github.projectunified.faststats.core
-
Main coordinator class that manages configuration, collects metrics, and submits telemetry payloads.
- Metrics.Builder - Class in io.github.projectunified.faststats.core
-
Builder class for
Metrics. - MinestomPlatform - Class in io.github.projectunified.faststats.minestom
-
Minestom implementation of
Platform. - MinestomPlatform() - Constructor for class io.github.projectunified.faststats.minestom.MinestomPlatform
-
Constructs a new
MinestomPlatform.
N
- NetSubmitter - Class in io.github.projectunified.faststats.net
-
Implementation of
Submitterthat usesHttpURLConnectionto submit GZIP-compressed telemetry payloads. - NetSubmitter(String) - Constructor for class io.github.projectunified.faststats.net.NetSubmitter
-
Constructs a new
NetSubmitterwith the default metrics URL (https://metrics.faststats.dev/v1/collect) and default user agent. - NetSubmitter(URL, String, String) - Constructor for class io.github.projectunified.faststats.net.NetSubmitter
-
Constructs a new
NetSubmitter. - NukkitPlatform - Class in io.github.projectunified.faststats.nukkit
-
Nukkit implementation of
Platform. - NukkitPlatform(PluginBase) - Constructor for class io.github.projectunified.faststats.nukkit.NukkitPlatform
-
Constructs a new
NukkitPlatformfor the given plugin. - number(String, Callable) - Static method in interface io.github.projectunified.faststats.core.Metric
-
Creates a new Number metric.
O
- onServerException(ServerExceptionEvent) - Method in class io.github.projectunified.faststats.paper.PaperErrorTracker
-
Handles server exceptions to track plugin errors.
- onShutdown() - Method in class io.github.projectunified.faststats.core.Feature
-
Called when the Metrics coordinator is shutdown.
- onShutdown() - Method in class io.github.projectunified.faststats.errortracker.ErrorTracker
- onShutdown() - Method in class io.github.projectunified.faststats.paper.PaperErrorTracker
- onStart() - Method in class io.github.projectunified.faststats.core.Feature
-
Called when the Metrics coordinator is started.
- onStart() - Method in class io.github.projectunified.faststats.errortracker.ErrorTracker
- onStart() - Method in class io.github.projectunified.faststats.paper.PaperErrorTracker
P
- PaperErrorTracker - Class in io.github.projectunified.faststats.paper
-
A feature that registers an event listener on Paper servers to track uncaught server plugin exceptions responsible by the registered plugin, reporting them to the core
ErrorTrackerfeature. - PaperErrorTracker(Plugin) - Constructor for class io.github.projectunified.faststats.paper.PaperErrorTracker
-
Constructs a new
PaperErrorTrackerfor the specified plugin. - platform(Platform) - Method in class io.github.projectunified.faststats.core.Metrics.Builder
-
Sets the platform implementation.
- Platform - Interface in io.github.projectunified.faststats.core
-
Represents the platform environment (e.g.
R
- read(Path) - Static method in class io.github.projectunified.faststats.core.DefaultConfig
-
Reads a config from the specified path with default settings.
- read(Path, String[], boolean, boolean) - Static method in class io.github.projectunified.faststats.core.DefaultConfig
-
Reads a config from the specified path with custom comments and external control flags.
S
- schedule(Runnable, long, long) - Method in interface io.github.projectunified.faststats.core.TaskScheduler
-
Schedules the task for periodic execution.
- scheduler(TaskScheduler) - Method in class io.github.projectunified.faststats.core.Metrics.Builder
-
Sets the task scheduler.
- serialize(Map) - Method in interface io.github.projectunified.faststats.core.Serializer
-
Serializes the given telemetry map into its JSON representation.
- serialize(Map) - Method in class io.github.projectunified.faststats.gson.GsonSerializer
- serializer(Serializer) - Method in class io.github.projectunified.faststats.core.Metrics.Builder
-
Sets the JSON serializer.
- Serializer - Interface in io.github.projectunified.faststats.core
-
Interface for serializing raw Java telemetry structures into standard JSON strings.
- setContextErrorHandler(BiConsumer) - Method in class io.github.projectunified.faststats.errortracker.ErrorTracker
-
Sets the error event handler.
- setDefaultProperty(Map) - Method in interface io.github.projectunified.faststats.core.Config
-
Sets default properties.
- setDefaultProperty(Map) - Method in class io.github.projectunified.faststats.core.DefaultConfig
- shutdown() - Method in class io.github.projectunified.faststats.core.Metrics
-
Shuts down the scheduler.
- shutdown() - Method in interface io.github.projectunified.faststats.core.TaskScheduler
-
Shuts down the scheduler, terminating any active scheduled task.
- SpongePlatform - Class in io.github.projectunified.faststats.sponge
-
Sponge implementation of
Platform. - SpongePlatform(PluginContainer, Logger, Path) - Constructor for class io.github.projectunified.faststats.sponge.SpongePlatform
-
Constructs a new
SpongePlatformfor the given plugin container. - start() - Method in class io.github.projectunified.faststats.core.Metrics
-
Starts the periodic scheduling of metrics submission with default initial delay (30 seconds, configurable via 'faststats.initial-delay' system property) and period (30 minutes).
- start(long, long) - Method in class io.github.projectunified.faststats.core.Metrics
-
Starts the periodic scheduling of metrics submission.
- string(String, Callable) - Static method in interface io.github.projectunified.faststats.core.Metric
-
Creates a new String metric.
- submit(Map, boolean) - Method in class io.github.projectunified.faststats.core.Feature
-
Submits the given data map payload.
- submitter(Submitter) - Method in class io.github.projectunified.faststats.core.Metrics.Builder
-
Sets the submitter.
- Submitter - Interface in io.github.projectunified.faststats.core
-
Interface to execute HTTP POST requests sending the JSON telemetry body to the server.
T
- TaskScheduler - Interface in io.github.projectunified.faststats.core
-
Interface representing the task scheduling mechanism for executing recurring telemetry submissions.
- TaskScheduler.Task - Interface in io.github.projectunified.faststats.core
-
Interface representing a scheduled task.
- trackError(String) - Method in class io.github.projectunified.faststats.errortracker.ErrorTracker
-
Tracks a handled error with the given message.
- trackError(String, boolean) - Method in class io.github.projectunified.faststats.errortracker.ErrorTracker
-
Tracks an error with the given message.
- trackError(Throwable) - Method in class io.github.projectunified.faststats.errortracker.ErrorTracker
-
Tracks a handled error.
- trackError(Throwable, boolean) - Method in class io.github.projectunified.faststats.errortracker.ErrorTracker
-
Tracks an error.
V
- VelocityPlatform - Class in io.github.projectunified.faststats.velocity
-
Velocity implementation of
Platform. - VelocityPlatform(ProxyServer, PluginContainer, Logger, Path) - Constructor for class io.github.projectunified.faststats.velocity.VelocityPlatform
-
Constructs a new
VelocityPlatformfor the given plugin.
All Classes and Interfaces|All Packages|Constant Field Values