Class ServerMetricsCollector

java.lang.Object

org.languagetool.server.ServerMetricsCollector

public class ServerMetricsCollector
extends Object

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	ServerMetricsCollector.RequestErrorType

Field Summary

Fields

Modifier and Type	Field	Description
private final io.prometheus.client.guava.cache.CacheMetricsCollector	cacheMetrics
private final io.prometheus.client.Counter	charactersCounter
private final io.prometheus.client.Counter	checkCounter
private final io.prometheus.client.Histogram	checkLatency
private final io.prometheus.client.Histogram	checkSize
private static final String	CLIENT_OTHER
private static final Set<String>	CLIENTS
private static final ServerMetricsCollector	collector
private final io.prometheus.client.Counter	computationTimeCounter
private final io.prometheus.client.Counter	failedHealthcheckCounter
private final io.prometheus.client.Gauge	hiddenMatchesServerEnabled
private final io.prometheus.client.Gauge	hiddenMatchesServerStatus
private final io.prometheus.client.Counter	httpRequestCounter
private final io.prometheus.client.Counter	httpResponseCounter
private static final double[]	LATENCY_BUCKETS
private final io.prometheus.client.Counter	matchCounter
private final io.prometheus.client.Counter	requestErrorCounter
private final io.prometheus.client.Counter	ruleMatchCounter
private static io.prometheus.client.exporter.HTTPServer	server
private static final double[]	SIZE_BUCKETS
static final String	UNKNOWN

Constructor Summary

Constructors

Constructor	Description
ServerMetricsCollector()

Method Summary

Modifier and Type	Method	Description
private @NotNull String	cleanClientLabel(@Nullable String client)
static ServerMetricsCollector	getInstance()
static void	init(int port)
void	logCheck(org.languagetool.Language language, long milliseconds, int textSize, int matchCount, org.languagetool.JLanguageTool.Mode mode, @Nullable String client, Map<String,Integer> ruleMatches)
void	logFailedHealthcheck()
void	logHiddenServerConfiguration(boolean enabled)
void	logHiddenServerStatus(boolean up)
void	logRequest()
void	logRequestError(ServerMetricsCollector.RequestErrorType type)
void	logResponse(int httpCode)
void	monitorCache(String name, com.google.common.cache.Cache cache)
static void	stop()

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

UNKNOWN

public static final String UNKNOWN

See Also:

• Constant Field Values

LATENCY_BUCKETS

private static final double[] LATENCY_BUCKETS

SIZE_BUCKETS

private static final double[] SIZE_BUCKETS

CLIENTS

private static final Set<String> CLIENTS

CLIENT_OTHER

private static final String CLIENT_OTHER

See Also:

• Constant Field Values

collector

private static final ServerMetricsCollector collector

server

private static io.prometheus.client.exporter.HTTPServer server

checkCounter

private final io.prometheus.client.Counter checkCounter

charactersCounter

private final io.prometheus.client.Counter charactersCounter

matchCounter

private final io.prometheus.client.Counter matchCounter

computationTimeCounter

private final io.prometheus.client.Counter computationTimeCounter

checkLatency

private final io.prometheus.client.Histogram checkLatency

checkSize

private final io.prometheus.client.Histogram checkSize

ruleMatchCounter

private final io.prometheus.client.Counter ruleMatchCounter

requestErrorCounter

private final io.prometheus.client.Counter requestErrorCounter

httpRequestCounter

private final io.prometheus.client.Counter httpRequestCounter

httpResponseCounter

private final io.prometheus.client.Counter httpResponseCounter

failedHealthcheckCounter

private final io.prometheus.client.Counter failedHealthcheckCounter

hiddenMatchesServerEnabled

private final io.prometheus.client.Gauge hiddenMatchesServerEnabled

hiddenMatchesServerStatus

private final io.prometheus.client.Gauge hiddenMatchesServerStatus

cacheMetrics

private final io.prometheus.client.guava.cache.CacheMetricsCollector cacheMetrics

Constructor Details

ServerMetricsCollector

public ServerMetricsCollector()

Method Details

init

public static void init(int port)
                 throws IOException

Throws:

IOException

stop

public static void stop()

getInstance

public static ServerMetricsCollector getInstance()

monitorCache

public void monitorCache(String name,
 com.google.common.cache.Cache cache)

logHiddenServerConfiguration

public void logHiddenServerConfiguration(boolean enabled)

logHiddenServerStatus

public void logHiddenServerStatus(boolean up)

logCheck

public void logCheck(org.languagetool.Language language,
 long milliseconds,
 int textSize,
 int matchCount,
 org.languagetool.JLanguageTool.Mode mode,
 @Nullable
 @Nullable String client,
 Map<String,Integer> ruleMatches)

cleanClientLabel

@NotNull
private @NotNull String cleanClientLabel(@Nullable
 @Nullable String client)

logRequestError

public void logRequestError(ServerMetricsCollector.RequestErrorType type)

logRequest

public void logRequest()

logResponse

public void logResponse(int httpCode)

logFailedHealthcheck

public void logFailedHealthcheck()