Compare commits

...

43 commits

Author SHA1 Message Date
ruscalworld
d5e8f412d7
Bump version & update publishing 2023-06-20 17:34:40 +03:00
ruscalworld
a74174a585
Shadow simpleclient_hotspot 2023-06-20 17:34:16 +03:00
ruscalworld
32be73bab8
Update README 2023-06-20 17:01:03 +03:00
ruscalworld
810e225915
Add Hotspot metrics 2023-06-20 16:56:40 +03:00
ruscalworld
0045d53a51
Update project structure 2023-06-20 16:36:41 +03:00
ruscalworld
8e8753da68
Adjust build.gradle code style, use minecraft_version property in modrinth publish 2023-06-20 16:12:41 +03:00
ruscalworld
2806a25203
Migrate to 1.20.1 2023-06-20 16:06:23 +03:00
ruscalworld
ca94f79373
Fix game version 2023-06-20 15:49:29 +03:00
ruscalworld
457c80de38
Update Dashboard preview URL in README.md 2023-06-20 15:46:48 +03:00
ruscalworld
10362e5517 Bump version 2023-01-28 13:43:49 +03:00
ruscalworld
07e2f576d1 Migrate to Minecraft 1.19.3 2023-01-28 13:43:20 +03:00
ruscalworld
cba601c709 Fix table formatting in readme 2023-01-28 13:29:06 +03:00
ruscalworld
64b3f89857 Fix build status badge 2023-01-28 13:27:22 +03:00
RuscalWorld
86afd547b7
Bump version 2022-07-26 16:22:19 +03:00
RuscalWorld
b9a4d7eea4
Improve logging in metric updater 2022-07-26 16:22:05 +03:00
RuscalWorld
2b402382f8
Give a name to the Timer for MetricUpdater 2022-07-26 16:18:24 +03:00
RuscalWorld
2f6fda00ed
Another way to fetch world entities (fixes #5) 2022-07-26 16:16:42 +03:00
RuscalWorld
d06ac8f173
Update prometheus client, increase gradle JVM heap space 2022-07-26 16:13:41 +03:00
RuscalWorld
6efb3bce81
Fix GitHub Actions 2022-07-01 00:18:04 +03:00
RuscalWorld
cca084fd70
Bump version 2022-07-01 00:15:23 +03:00
RuscalWorld
f5dfe25cec
Migrate to Minecraft 1.19
Support of old Minecraft versions is dropped now
2022-07-01 00:15:22 +03:00
RuscalWorld
a3f39f5e65
Update Prometheus client 2021-12-11 14:46:51 +03:00
RuscalWorld
257b6d30c0
Bump version 2021-12-03 14:15:48 +03:00
RuscalWorld
9111ae9dcc
1.18 2021-12-03 14:15:29 +03:00
RuscalWorld
ee48cefe3c
Bump version 2021-09-07 22:22:26 +03:00
RuscalWorld
3cee0a1ba3
Fix changing MSPT gauge value without label (#1) 2021-09-07 22:21:56 +03:00
RuscalWorld
5c688104ea
Show all supported versions on Modrinth 2021-08-06 17:16:36 +03:00
RuscalWorld
f3f8ba66eb
Bump version 2021-08-06 17:05:56 +03:00
RuscalWorld
b921bc5c2c
Forcibly disable TPS and MSPT metrics if spark mod is not installed 2021-08-06 17:03:40 +03:00
RuscalWorld
3dc5c21474
Add backwards compatibility with Minecraft 1.16.5 (#2) 2021-08-06 16:51:40 +03:00
RuscalWorld
ec9349dce0
Check if spark enabled before registering metrics that require it 2021-06-26 11:26:34 +03:00
RuscalWorld
0e96325c79
Fix typo in config 2021-06-24 22:19:32 +03:00
RuscalWorld
235ec91332
Update version 2021-06-24 22:18:43 +03:00
RuscalWorld
95626ceaa7
Optimize imports 2021-06-24 22:18:27 +03:00
RuscalWorld
918a3785bd
Merge remote-tracking branch 'origin/master' 2021-06-24 22:15:17 +03:00
RuscalWorld
9126d9ba2e
Add support for Minecraft 1.17 2021-06-24 22:15:04 +03:00
Nikolay
9555ad4606
Fix typo 2021-06-10 15:51:53 +03:00
RuscalWorld
8aba2e8048
Bump version 2021-05-26 00:56:25 +03:00
RuscalWorld
9b331b84c7
Rename publish job 2021-05-26 00:55:38 +03:00
RuscalWorld
88c14f8624
Bump version 2021-05-26 00:47:42 +03:00
RuscalWorld
82f10e589e
Add Modrinth token in CI 2021-05-26 00:46:15 +03:00
Nikolay
d7c3dd6bd6
Fix CI again 2021-05-26 00:42:38 +03:00
Nikolay
53c9386f97
Attempt to fix CI 2021-05-26 00:39:47 +03:00
24 changed files with 357 additions and 251 deletions

View file

@ -11,10 +11,10 @@ jobs:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v2
- name: Set up JDK 11
- name: Set up JDK 17
uses: actions/setup-java@v2
with:
java-version: '11'
java-version: '17'
distribution: 'adopt'
- name: Grant execute permission for gradlew
run: chmod +x gradlew

View file

@ -2,19 +2,21 @@ name: Publish on Modrinth
on:
release:
types: [ created ]
types: [ created ]
jobs:
build:
publish:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v2
- name: Set up JDK 11
- name: Set up JDK 8
uses: actions/setup-java@v2
with:
java-version: '11'
java-version: '8'
distribution: 'adopt'
- name: Grant execute permission for gradlew
run: chmod +x gradlew
- name: Build with Gradle and publish on Modrinth
run: ./gradlew publish
env:
MODRINTH_TOKEN: ${{ secrets.MODRINTH_TOKEN }}

View file

@ -1,11 +1,11 @@
# FabricExporter
![](https://img.shields.io/github/license/RuscalWorld/FabricExporter)
![](https://img.shields.io/github/workflow/status/RuscalWorld/FabricExporter/Build)
![](https://img.shields.io/github/license/ruscalworld/fabric-exporter)
![](https://img.shields.io/github/actions/workflow/status/ruscalworld/fabric-exporter/gradle.yml?branch=master)
Fabric mod that adds a Prometheus exporter with general metrics of your server.
![Grafana Dashboard](https://img.share.superhub.xyz/2oiycx.png)
![Grafana Dashboard](https://grafana.com/api/dashboards/14492/images/10444/image)
---
@ -24,15 +24,16 @@ Here is a list of metrics that are collected by FabricExporter.
You can disable any of these metrics in [config](src/main/resources/config/exporter.properties).
| Prometheus name | Description | Config property | Collected by |
| --------------- | ----------- | --------------- | ------------ |
| `minecraft_loaded_chunks` | Amount of currently loaded chunks on server | `enable-loaded-chunks` | Minecraft |
| `minecraft_total_loaded_chunks` | Amount of total loaded chunks on server | `enable-total-loaded-chunks` | Minecraft |
| `minecraft_mspt` | Count of milliseconds per tick (MSPT) | `enable-mspt` | Spark |
| `minecraft_tps` | Count of ticks per second (TPS) | `enable-tps` | Spark |
| `minecraft_players_online` | Amount of currently online players on your server | `enable-players-online` | FabricExporter |
| `minecraft_entities` | Amount of currently loaded entities on your server | `enable-entities` | FabricExporter |
| `minecraft_handshakes` | Count of handshake requests | `enable-handshakes` | FabricExporter |
| Prometheus name | Description | Config property | Collected by |
|---------------------------------|-----------------------------------------------------------------------------------------|------------------------------|-------------------|
| `minecraft_loaded_chunks` | Amount of currently loaded chunks on server | `enable-loaded-chunks` | Minecraft |
| `minecraft_total_loaded_chunks` | Amount of total loaded chunks on server | `enable-total-loaded-chunks` | Minecraft |
| `minecraft_mspt` | Count of milliseconds per tick (MSPT) | `enable-mspt` | Spark |
| `minecraft_tps` | Count of ticks per second (TPS) | `enable-tps` | Spark |
| `minecraft_players_online` | Amount of currently online players on your server | `enable-players-online` | FabricExporter |
| `minecraft_entities` | Amount of currently loaded entities on your server | `enable-entities` | FabricExporter |
| `minecraft_handshakes` | Count of handshake requests | `enable-handshakes` | FabricExporter |
| `jvm_*` | JVM metrics collected by [Prometheus client](https://github.com/prometheus/client_java) | `export-jvm-metrics` | Prometheus client |
## Getting started
@ -40,7 +41,7 @@ To use this mod you should have at least Fabric server and Prometheus installed.
### Installing mod
1. Download the mod from [Releases](https://github.com/RuscalWorld/FabricExporter/releases) page.
1. Download the mod from [Releases](https://github.com/ruscalworld/fabric-exporter/releases) page.
2. Drop downloaded mod jar to the `mods` folder.
3. Start your server to generate config file.
4. Open `config/exporter.properties`, ensure that `server-port` value is an open port that can be accessed by your Prometheus and change it if required.
@ -81,16 +82,16 @@ In this file you can see some general settings and metrics settings.
### General settings
| Property | Description | Default value |
| -------- | ----------- | ------------- |
| `server-port` | Port on what the web server will listen for requests | `25585` |
| `update-interval` | Interval between gauge metrics updates in milliseconds | `1000` |
| `use-spark` | If set to `false`, FabricExporter will be independent from Spark | `true` |
| Property | Description | Default value |
|-------------------|------------------------------------------------------------------|---------------|
| `server-port` | Port on what the web server will listen for requests | `25585` |
| `update-interval` | Interval between gauge metrics updates in milliseconds | `1000` |
| `use-spark` | If set to `false`, FabricExporter will be independent from Spark | `true` |
### Metrics settings
You can disable any metric that registered via MetricRegistry (all metrics by default) using the settings below.
Names of properties consist of `enabled` and metric name without prefix and `_` replaced with `-`.
You can disable any metric that registered via MetricRegistry (all metrics by default) using `exporter.properties` file.
Names of properties consist of `enable` and metric name without prefix and `_` replaced with `-`.
For example, if you want to disable `minecraft_players_online`, you should set `enable-players-online` to `false`.
You can also see list of available properties in "Exposed metrics" section.
If you can't find property for some metrics, you can manually add it.

View file

@ -1,16 +1,9 @@
import net.fabricmc.loom.task.RemapJarTask
import com.modrinth.minotaur.TaskModrinthUpload
buildscript {
dependencies {
classpath 'com.github.jengelman.gradle.plugins:shadow:6.1.0'
}
}
plugins {
id 'com.github.johnrengelman.shadow' version '6.1.0'
id "com.modrinth.minotaur" version "1.1.0"
id 'fabric-loom' version '0.6-SNAPSHOT'
id 'com.github.johnrengelman.shadow' version '7.1.2'
id 'com.modrinth.minotaur' version '2.+'
id 'fabric-loom' version '0.12-SNAPSHOT'
id 'maven-publish'
}
@ -20,10 +13,8 @@ repositories {
}
}
apply plugin: 'com.github.johnrengelman.shadow'
sourceCompatibility = JavaVersion.VERSION_1_8
targetCompatibility = JavaVersion.VERSION_1_8
sourceCompatibility = JavaVersion.VERSION_17
targetCompatibility = JavaVersion.VERSION_17
archivesBaseName = project.archives_base_name
version = project.mod_version
@ -40,70 +31,78 @@ dependencies {
// PSA: Some older mods, compiled on Loom 0.2.1, might have outdated Maven POMs.
// You may need to force-disable transitiveness on them.
compile "io.prometheus:simpleclient:${project.prometheus_version}"
compile "io.prometheus:simpleclient_httpserver:${project.prometheus_version}"
implementation "io.prometheus:simpleclient:${project.prometheus_version}"
implementation "io.prometheus:simpleclient_httpserver:${project.prometheus_version}"
implementation "io.prometheus:simpleclient_hotspot:${project.prometheus_version}"
compileOnly "me.lucko:spark-api:0.1-SNAPSHOT"
}
processResources {
inputs.property "version", project.version
inputs.property 'version', project.version
duplicatesStrategy = DuplicatesStrategy.INCLUDE
from(sourceSets.main.resources.srcDirs) {
include "fabric.mod.json"
expand "version": project.version
include 'fabric.mod.json'
expand 'version': project.version
}
from(sourceSets.main.resources.srcDirs) {
exclude "fabric.mod.json"
exclude 'fabric.mod.json'
}
}
// ensure that the encoding is set to UTF-8, no matter what the system default is
// this fixes some edge cases with special characters not displaying correctly
// see http://yodaconditions.net/blog/fix-for-java-file-encoding-problems-with-gradle.html
tasks.withType(JavaCompile) {
tasks.withType(JavaCompile).configureEach {
options.encoding = "UTF-8"
}
// Loom will automatically attach sourcesJar to a RemapSourcesJar task and to the "build" task
// if it is present.
// If you remove this task, sources will not be generated.
task sourcesJar(type: Jar, dependsOn: classes) {
classifier = "sources"
tasks.register('sourcesJar', Jar) {
dependsOn classes
from sourceSets.main.allSource
}
jar {
from "LICENSE"
from 'LICENSE'
}
shadowJar {
archiveClassifier = "shaded-dev"
archiveClassifier = 'shaded-dev'
dependencies {
include dependency("io.prometheus:simpleclient:${project.prometheus_version}")
include dependency("io.prometheus:simpleclient_common:${project.prometheus_version}")
include dependency("io.prometheus:simpleclient_httpserver:${project.prometheus_version}")
include dependency("io.prometheus:simpleclient_hotspot:${project.prometheus_version}")
}
}
task remapShadowJar(type: RemapJarTask, dependsOn: shadowJar) {
tasks.register('remapShadowJar', RemapJarTask) {
dependsOn shadowJar
input = shadowJar.archiveFile
archiveFileName = shadowJar.archiveFileName.get().replaceAll("-shaded-dev\\.jar\$", ".jar")
archiveFileName = shadowJar.archiveFileName.get().replaceAll('-shaded-dev\\.jar\$', '.jar')
addNestedDependencies = true
remapAccessWidener = true
}
modrinth {
token = System.getenv('MODRINTH_TOKEN')
projectId = 'dbVXHSlv'
versionNumber = project.mod_version
versionType = 'release'
uploadFile = remapShadowJar
gameVersions.add(project.minecraft_version)
loaders.add('fabric')
dependencies {
required.project 'fabric-api'
optional.project 'spark'
}
}
assemble.dependsOn(remapShadowJar)
task publishModrinth(type: TaskModrinthUpload, dependsOn: remapShadowJar) {
onlyIf { System.getenv("MODRINTH_TOKEN") }
token = System.getenv("MODRINTH_TOKEN")
projectId = 'dbVXHSlv'
versionNumber = project.mod_version
uploadFile = remapShadowJar
addGameVersion(project.minecraft_version)
addLoader('fabric')
}

View file

@ -1,15 +1,15 @@
# Done to increase the memory available to gradle.
org.gradle.jvmargs=-Xmx1G
org.gradle.jvmargs=-Xmx2G
# Fabric Properties
# check these on https://modmuss50.me/fabric.html
minecraft_version=1.16.5
yarn_mappings=1.16.5+build.9
loader_version=0.11.3
minecraft_version=1.20.1
yarn_mappings=1.20.1+build.2
loader_version=0.14.21
# Mod Properties
mod_version=1.0.0
mod_version=1.0.10
maven_group=ru.ruscalworld
archives_base_name=fabricexporter
# Dependencies
# check this on https://modmuss50.me/fabric.html
fabric_version=0.25.1+build.416-1.16
prometheus_version=0.10.0
fabric_version=0.83.1+1.20.1
prometheus_version=0.16.0

Binary file not shown.

View file

@ -1,5 +1,5 @@
distributionBase=GRADLE_USER_HOME
distributionPath=wrapper/dists
distributionUrl=https\://services.gradle.org/distributions/gradle-6.5.1-bin.zip
distributionUrl=https\://services.gradle.org/distributions/gradle-7.4.2-bin.zip
zipStoreBase=GRADLE_USER_HOME
zipStorePath=wrapper/dists

269
gradlew vendored
View file

@ -1,7 +1,7 @@
#!/usr/bin/env sh
#!/bin/sh
#
# Copyright 2015 the original author or authors.
# Copyright © 2015-2021 the original authors.
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
@ -17,67 +17,101 @@
#
##############################################################################
##
## Gradle start up script for UN*X
##
#
# Gradle start up script for POSIX generated by Gradle.
#
# Important for running:
#
# (1) You need a POSIX-compliant shell to run this script. If your /bin/sh is
# noncompliant, but you have some other compliant shell such as ksh or
# bash, then to run this script, type that shell name before the whole
# command line, like:
#
# ksh Gradle
#
# Busybox and similar reduced shells will NOT work, because this script
# requires all of these POSIX shell features:
# * functions;
# * expansions «$var», «${var}», «${var:-default}», «${var+SET}»,
# «${var#prefix}», «${var%suffix}», and «$( cmd )»;
# * compound commands having a testable exit status, especially «case»;
# * various built-in commands including «command», «set», and «ulimit».
#
# Important for patching:
#
# (2) This script targets any POSIX shell, so it avoids extensions provided
# by Bash, Ksh, etc; in particular arrays are avoided.
#
# The "traditional" practice of packing multiple parameters into a
# space-separated string is a well documented source of bugs and security
# problems, so this is (mostly) avoided, by progressively accumulating
# options in "$@", and eventually passing that to Java.
#
# Where the inherited environment variables (DEFAULT_JVM_OPTS, JAVA_OPTS,
# and GRADLE_OPTS) rely on word-splitting, this is performed explicitly;
# see the in-line comments for details.
#
# There are tweaks for specific operating systems such as AIX, CygWin,
# Darwin, MinGW, and NonStop.
#
# (3) This script is generated from the Groovy template
# https://github.com/gradle/gradle/blob/master/subprojects/plugins/src/main/resources/org/gradle/api/internal/plugins/unixStartScript.txt
# within the Gradle project.
#
# You can find Gradle at https://github.com/gradle/gradle/.
#
##############################################################################
# Attempt to set APP_HOME
# Resolve links: $0 may be a link
PRG="$0"
# Need this for relative symlinks.
while [ -h "$PRG" ] ; do
ls=`ls -ld "$PRG"`
link=`expr "$ls" : '.*-> \(.*\)$'`
if expr "$link" : '/.*' > /dev/null; then
PRG="$link"
else
PRG=`dirname "$PRG"`"/$link"
fi
app_path=$0
# Need this for daisy-chained symlinks.
while
APP_HOME=${app_path%"${app_path##*/}"} # leaves a trailing /; empty if no leading path
[ -h "$app_path" ]
do
ls=$( ls -ld "$app_path" )
link=${ls#*' -> '}
case $link in #(
/*) app_path=$link ;; #(
*) app_path=$APP_HOME$link ;;
esac
done
SAVED="`pwd`"
cd "`dirname \"$PRG\"`/" >/dev/null
APP_HOME="`pwd -P`"
cd "$SAVED" >/dev/null
APP_HOME=$( cd "${APP_HOME:-./}" && pwd -P ) || exit
APP_NAME="Gradle"
APP_BASE_NAME=`basename "$0"`
APP_BASE_NAME=${0##*/}
# Add default JVM options here. You can also use JAVA_OPTS and GRADLE_OPTS to pass JVM options to this script.
DEFAULT_JVM_OPTS='"-Xmx64m" "-Xms64m"'
# Use the maximum available, or set MAX_FD != -1 to use that value.
MAX_FD="maximum"
MAX_FD=maximum
warn () {
echo "$*"
}
} >&2
die () {
echo
echo "$*"
echo
exit 1
}
} >&2
# OS specific support (must be 'true' or 'false').
cygwin=false
msys=false
darwin=false
nonstop=false
case "`uname`" in
CYGWIN* )
cygwin=true
;;
Darwin* )
darwin=true
;;
MINGW* )
msys=true
;;
NONSTOP* )
nonstop=true
;;
case "$( uname )" in #(
CYGWIN* ) cygwin=true ;; #(
Darwin* ) darwin=true ;; #(
MSYS* | MINGW* ) msys=true ;; #(
NONSTOP* ) nonstop=true ;;
esac
CLASSPATH=$APP_HOME/gradle/wrapper/gradle-wrapper.jar
@ -87,9 +121,9 @@ CLASSPATH=$APP_HOME/gradle/wrapper/gradle-wrapper.jar
if [ -n "$JAVA_HOME" ] ; then
if [ -x "$JAVA_HOME/jre/sh/java" ] ; then
# IBM's JDK on AIX uses strange locations for the executables
JAVACMD="$JAVA_HOME/jre/sh/java"
JAVACMD=$JAVA_HOME/jre/sh/java
else
JAVACMD="$JAVA_HOME/bin/java"
JAVACMD=$JAVA_HOME/bin/java
fi
if [ ! -x "$JAVACMD" ] ; then
die "ERROR: JAVA_HOME is set to an invalid directory: $JAVA_HOME
@ -98,7 +132,7 @@ Please set the JAVA_HOME variable in your environment to match the
location of your Java installation."
fi
else
JAVACMD="java"
JAVACMD=java
which java >/dev/null 2>&1 || die "ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH.
Please set the JAVA_HOME variable in your environment to match the
@ -106,80 +140,95 @@ location of your Java installation."
fi
# Increase the maximum file descriptors if we can.
if [ "$cygwin" = "false" -a "$darwin" = "false" -a "$nonstop" = "false" ] ; then
MAX_FD_LIMIT=`ulimit -H -n`
if [ $? -eq 0 ] ; then
if [ "$MAX_FD" = "maximum" -o "$MAX_FD" = "max" ] ; then
MAX_FD="$MAX_FD_LIMIT"
fi
ulimit -n $MAX_FD
if [ $? -ne 0 ] ; then
warn "Could not set maximum file descriptor limit: $MAX_FD"
fi
else
warn "Could not query maximum file descriptor limit: $MAX_FD_LIMIT"
fi
fi
# For Darwin, add options to specify how the application appears in the dock
if $darwin; then
GRADLE_OPTS="$GRADLE_OPTS \"-Xdock:name=$APP_NAME\" \"-Xdock:icon=$APP_HOME/media/gradle.icns\""
fi
# For Cygwin or MSYS, switch paths to Windows format before running java
if [ "$cygwin" = "true" -o "$msys" = "true" ] ; then
APP_HOME=`cygpath --path --mixed "$APP_HOME"`
CLASSPATH=`cygpath --path --mixed "$CLASSPATH"`
JAVACMD=`cygpath --unix "$JAVACMD"`
# We build the pattern for arguments to be converted via cygpath
ROOTDIRSRAW=`find -L / -maxdepth 1 -mindepth 1 -type d 2>/dev/null`
SEP=""
for dir in $ROOTDIRSRAW ; do
ROOTDIRS="$ROOTDIRS$SEP$dir"
SEP="|"
done
OURCYGPATTERN="(^($ROOTDIRS))"
# Add a user-defined pattern to the cygpath arguments
if [ "$GRADLE_CYGPATTERN" != "" ] ; then
OURCYGPATTERN="$OURCYGPATTERN|($GRADLE_CYGPATTERN)"
fi
# Now convert the arguments - kludge to limit ourselves to /bin/sh
i=0
for arg in "$@" ; do
CHECK=`echo "$arg"|egrep -c "$OURCYGPATTERN" -`
CHECK2=`echo "$arg"|egrep -c "^-"` ### Determine if an option
if [ $CHECK -ne 0 ] && [ $CHECK2 -eq 0 ] ; then ### Added a condition
eval `echo args$i`=`cygpath --path --ignore --mixed "$arg"`
else
eval `echo args$i`="\"$arg\""
fi
i=`expr $i + 1`
done
case $i in
0) set -- ;;
1) set -- "$args0" ;;
2) set -- "$args0" "$args1" ;;
3) set -- "$args0" "$args1" "$args2" ;;
4) set -- "$args0" "$args1" "$args2" "$args3" ;;
5) set -- "$args0" "$args1" "$args2" "$args3" "$args4" ;;
6) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" ;;
7) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" "$args6" ;;
8) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" "$args6" "$args7" ;;
9) set -- "$args0" "$args1" "$args2" "$args3" "$args4" "$args5" "$args6" "$args7" "$args8" ;;
if ! "$cygwin" && ! "$darwin" && ! "$nonstop" ; then
case $MAX_FD in #(
max*)
MAX_FD=$( ulimit -H -n ) ||
warn "Could not query maximum file descriptor limit"
esac
case $MAX_FD in #(
'' | soft) :;; #(
*)
ulimit -n "$MAX_FD" ||
warn "Could not set maximum file descriptor limit to $MAX_FD"
esac
fi
# Escape application args
save () {
for i do printf %s\\n "$i" | sed "s/'/'\\\\''/g;1s/^/'/;\$s/\$/' \\\\/" ; done
echo " "
}
APP_ARGS=`save "$@"`
# Collect all arguments for the java command, stacking in reverse order:
# * args from the command line
# * the main class name
# * -classpath
# * -D...appname settings
# * --module-path (only if needed)
# * DEFAULT_JVM_OPTS, JAVA_OPTS, and GRADLE_OPTS environment variables.
# Collect all arguments for the java command, following the shell quoting and substitution rules
eval set -- $DEFAULT_JVM_OPTS $JAVA_OPTS $GRADLE_OPTS "\"-Dorg.gradle.appname=$APP_BASE_NAME\"" -classpath "\"$CLASSPATH\"" org.gradle.wrapper.GradleWrapperMain "$APP_ARGS"
# For Cygwin or MSYS, switch paths to Windows format before running java
if "$cygwin" || "$msys" ; then
APP_HOME=$( cygpath --path --mixed "$APP_HOME" )
CLASSPATH=$( cygpath --path --mixed "$CLASSPATH" )
JAVACMD=$( cygpath --unix "$JAVACMD" )
# Now convert the arguments - kludge to limit ourselves to /bin/sh
for arg do
if
case $arg in #(
-*) false ;; # don't mess with options #(
/?*) t=${arg#/} t=/${t%%/*} # looks like a POSIX filepath
[ -e "$t" ] ;; #(
*) false ;;
esac
then
arg=$( cygpath --path --ignore --mixed "$arg" )
fi
# Roll the args list around exactly as many times as the number of
# args, so each arg winds up back in the position where it started, but
# possibly modified.
#
# NB: a `for` loop captures its iteration list before it begins, so
# changing the positional parameters here affects neither the number of
# iterations, nor the values presented in `arg`.
shift # remove old arg
set -- "$@" "$arg" # push replacement arg
done
fi
# Collect all arguments for the java command;
# * $DEFAULT_JVM_OPTS, $JAVA_OPTS, and $GRADLE_OPTS can contain fragments of
# shell script including quotes and variable substitutions, so put them in
# double quotes to make sure that they get re-expanded; and
# * put everything else in single quotes, so that it's not re-expanded.
set -- \
"-Dorg.gradle.appname=$APP_BASE_NAME" \
-classpath "$CLASSPATH" \
org.gradle.wrapper.GradleWrapperMain \
"$@"
# Use "xargs" to parse quoted args.
#
# With -n1 it outputs one arg per line, with the quotes and backslashes removed.
#
# In Bash we could simply go:
#
# readarray ARGS < <( xargs -n1 <<<"$var" ) &&
# set -- "${ARGS[@]}" "$@"
#
# but POSIX shell has neither arrays nor command substitution, so instead we
# post-process each arg (as a line of input to sed) to backslash-escape any
# character that might be a shell metacharacter, then use eval to reverse
# that process (while maintaining the separation between arguments), and wrap
# the whole thing up as a single "set" statement.
#
# This will of course break if any of these variables contains a newline or
# an unmatched quote.
#
eval "set -- $(
printf '%s\n' "$DEFAULT_JVM_OPTS $JAVA_OPTS $GRADLE_OPTS" |
xargs -n1 |
sed ' s~[^-[:alnum:]+,./:=@_]~\\&~g; ' |
tr '\n' ' '
)" '"$@"'
exec "$JAVACMD" "$@"

21
gradlew.bat vendored
View file

@ -40,7 +40,7 @@ if defined JAVA_HOME goto findJavaFromJavaHome
set JAVA_EXE=java.exe
%JAVA_EXE% -version >NUL 2>&1
if "%ERRORLEVEL%" == "0" goto init
if "%ERRORLEVEL%" == "0" goto execute
echo.
echo ERROR: JAVA_HOME is not set and no 'java' command could be found in your PATH.
@ -54,7 +54,7 @@ goto fail
set JAVA_HOME=%JAVA_HOME:"=%
set JAVA_EXE=%JAVA_HOME%/bin/java.exe
if exist "%JAVA_EXE%" goto init
if exist "%JAVA_EXE%" goto execute
echo.
echo ERROR: JAVA_HOME is set to an invalid directory: %JAVA_HOME%
@ -64,21 +64,6 @@ echo location of your Java installation.
goto fail
:init
@rem Get command-line arguments, handling Windows variants
if not "%OS%" == "Windows_NT" goto win9xME_args
:win9xME_args
@rem Slurp the command line arguments.
set CMD_LINE_ARGS=
set _SKIP=2
:win9xME_args_slurp
if "x%~1" == "x" goto execute
set CMD_LINE_ARGS=%*
:execute
@rem Setup the command line
@ -86,7 +71,7 @@ set CLASSPATH=%APP_HOME%\gradle\wrapper\gradle-wrapper.jar
@rem Execute Gradle
"%JAVA_EXE%" %DEFAULT_JVM_OPTS% %JAVA_OPTS% %GRADLE_OPTS% "-Dorg.gradle.appname=%APP_BASE_NAME%" -classpath "%CLASSPATH%" org.gradle.wrapper.GradleWrapperMain %CMD_LINE_ARGS%
"%JAVA_EXE%" %DEFAULT_JVM_OPTS% %JAVA_OPTS% %GRADLE_OPTS% "-Dorg.gradle.appname=%APP_BASE_NAME%" -classpath "%CLASSPATH%" org.gradle.wrapper.GradleWrapperMain %*
:end
@rem End local scope for the variables with windows NT shell

View file

@ -1,6 +1,5 @@
pluginManagement {
repositories {
jcenter()
maven {
name = 'Fabric'
url = 'https://maven.fabricmc.net/'

View file

@ -1,16 +1,21 @@
package ru.ruscalworld.fabricexporter;
import io.prometheus.client.exporter.HTTPServer;
import io.prometheus.client.hotspot.DefaultExports;
import net.fabricmc.api.ModInitializer;
import net.fabricmc.fabric.api.event.lifecycle.v1.ServerLifecycleEvents;
import net.fabricmc.loader.api.FabricLoader;
import net.fabricmc.loader.api.ModContainer;
import net.minecraft.server.MinecraftServer;
import org.apache.logging.log4j.LogManager;
import org.apache.logging.log4j.Logger;
import ru.ruscalworld.fabricexporter.config.MainConfig;
import java.io.IOException;
import java.util.Optional;
public class FabricExporter implements ModInitializer {
private static final Logger logger = LogManager.getLogger();
private static FabricExporter instance;
private MinecraftServer server;
@ -29,10 +34,21 @@ public class FabricExporter implements ModInitializer {
e.printStackTrace();
}
Optional<ModContainer> spark = FabricLoader.getInstance().getModContainer("spark");
if (spark.isEmpty() && config.shouldUseSpark()) {
config.setShouldUseSpark(false);
logger.warn("Spark mod is not installed, but \"use-spark\" property is enabled! TPS and MSPT metrics will be disabled.");
logger.warn("To fix this, you should either set \"use-spark\" in exporter.properties to false or install Spark mod (https://spark.lucko.me).");
}
MetricRegistry metricRegistry = new MetricRegistry(this);
metricRegistry.registerDefault();
this.setMetricRegistry(metricRegistry);
if (config.shouldExportJvmDefaults()) {
DefaultExports.initialize();
}
ServerLifecycleEvents.SERVER_STARTING.register(this::setServer);
ServerLifecycleEvents.SERVER_STARTED.register(server -> {
try {
@ -47,8 +63,8 @@ public class FabricExporter implements ModInitializer {
});
ServerLifecycleEvents.SERVER_STOPPING.register(server -> {
this.getHttpServer().stop();
this.getMetricRegistry().getTimer().cancel();
this.getHttpServer().close();
this.getMetricRegistry().getMetricUpdaterTimer().cancel();
});
instance = this;

View file

@ -4,7 +4,14 @@ import io.prometheus.client.Collector;
import io.prometheus.client.Counter;
import io.prometheus.client.SimpleCollector;
import ru.ruscalworld.fabricexporter.config.MainConfig;
import ru.ruscalworld.fabricexporter.metrics.*;
import ru.ruscalworld.fabricexporter.metrics.Metric;
import ru.ruscalworld.fabricexporter.metrics.spark.MillisPerTick;
import ru.ruscalworld.fabricexporter.metrics.spark.SparkMetric;
import ru.ruscalworld.fabricexporter.metrics.spark.TicksPerSecond;
import ru.ruscalworld.fabricexporter.metrics.world.Entities;
import ru.ruscalworld.fabricexporter.metrics.world.LoadedChunks;
import ru.ruscalworld.fabricexporter.metrics.world.OnlinePlayers;
import ru.ruscalworld.fabricexporter.metrics.world.TotalLoadedChunks;
import java.util.ArrayList;
import java.util.HashMap;
@ -15,18 +22,18 @@ public class MetricRegistry {
private final FabricExporter exporter;
private final List<Metric> metrics = new ArrayList<>();
private final HashMap<String, Collector> customMetrics = new HashMap<>();
private final Timer timer;
private final Timer metricUpdaterTimer;
public MetricRegistry(FabricExporter exporter) {
this.exporter = exporter;
timer = new Timer();
metricUpdaterTimer = new Timer("Metric Updater Timer");
}
public void runUpdater() {
MainConfig config = this.getExporter().getConfig();
MetricUpdater metricUpdater = new MetricUpdater(this.getExporter());
this.getMetrics().forEach(metricUpdater::registerMetric);
this.getTimer().schedule(metricUpdater, 1000, config.getUpdateInterval());
this.getMetricUpdaterTimer().schedule(metricUpdater, 1000, config.getUpdateInterval());
}
public void registerDefault() {
@ -34,8 +41,11 @@ public class MetricRegistry {
this.registerMetric(new Entities());
this.registerMetric(new LoadedChunks());
this.registerMetric(new TotalLoadedChunks());
this.registerMetric(new TicksPerSecond());
this.registerMetric(new MillisPerTick());
if (this.getExporter().getConfig().shouldUseSpark()) {
this.registerMetric(new TicksPerSecond());
this.registerMetric(new MillisPerTick());
}
this.registerCustomMetric("handshakes", new Counter.Builder()
.name(getMetricName("handshakes"))
@ -76,8 +86,8 @@ public class MetricRegistry {
return exporter;
}
public Timer getTimer() {
return timer;
public Timer getMetricUpdaterTimer() {
return metricUpdaterTimer;
}
public HashMap<String, Collector> getCustomMetrics() {

View file

@ -1,5 +1,7 @@
package ru.ruscalworld.fabricexporter;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import ru.ruscalworld.fabricexporter.metrics.Metric;
import java.util.ArrayList;
@ -7,6 +9,7 @@ import java.util.List;
import java.util.TimerTask;
public class MetricUpdater extends TimerTask {
private final static Logger logger = LoggerFactory.getLogger("MetricUpdater");
private final List<Metric> metrics = new ArrayList<>();
private final FabricExporter exporter;
@ -20,7 +23,7 @@ public class MetricUpdater extends TimerTask {
try {
metric.update(this.getExporter());
} catch (Exception exception) {
exception.printStackTrace();
logger.error("Error updating metric " + metric.getName(), exception);
}
}
}

View file

@ -8,6 +8,7 @@ public class MainConfig extends Config {
private int port;
private int updateInterval;
private boolean useSpark;
private boolean exportJvmDefaults;
public MainConfig(String name) {
super(name);
@ -24,6 +25,8 @@ public class MainConfig extends Config {
this.setUpdateInterval(ConvertUtil.intToStringOrDefault(updateIntervalString, 1000));
this.setShouldUseSpark(properties.getProperty("use-spark", "true").equalsIgnoreCase("true"));
this.setShouldExportJvmDefaults(properties.getProperty("export-default-jvm-metrics", "true").equalsIgnoreCase("true"));
}
public int getPort() {
@ -49,4 +52,12 @@ public class MainConfig extends Config {
public void setShouldUseSpark(boolean useSpark) {
this.useSpark = useSpark;
}
public boolean shouldExportJvmDefaults() {
return exportJvmDefaults;
}
public void setShouldExportJvmDefaults(boolean exportJvmDefaults) {
this.exportJvmDefaults = exportJvmDefaults;
}
}

View file

@ -1,23 +0,0 @@
package ru.ruscalworld.fabricexporter.metrics;
import me.lucko.spark.api.statistic.StatisticWindow;
import me.lucko.spark.api.statistic.misc.DoubleAverageInfo;
import me.lucko.spark.api.statistic.types.GenericStatistic;
import ru.ruscalworld.fabricexporter.FabricExporter;
public class MillisPerTick extends SparkMetric {
public MillisPerTick() {
super("mspt", "Milliseconds per tick (MSPT)", "type");
}
@Override
public void update(FabricExporter exporter) {
GenericStatistic<DoubleAverageInfo, StatisticWindow.MillisPerTick> mspt = this.getSpark().mspt();
if (mspt == null) this.getGauge().set(0);
else {
this.getGauge().labels("min").set(mspt.poll(StatisticWindow.MillisPerTick.MINUTES_1).min());
this.getGauge().labels("mean").set(mspt.poll(StatisticWindow.MillisPerTick.MINUTES_1).mean());
this.getGauge().labels("max").set(mspt.poll(StatisticWindow.MillisPerTick.MINUTES_1).max());
}
}
}

View file

@ -0,0 +1,29 @@
package ru.ruscalworld.fabricexporter.metrics.spark;
import me.lucko.spark.api.statistic.StatisticWindow;
import me.lucko.spark.api.statistic.misc.DoubleAverageInfo;
import me.lucko.spark.api.statistic.types.GenericStatistic;
import ru.ruscalworld.fabricexporter.FabricExporter;
public class MillisPerTick extends SparkMetric {
public MillisPerTick() {
super("mspt", "Milliseconds per tick (MSPT)", "type");
}
@Override
public void update(FabricExporter exporter) {
GenericStatistic<DoubleAverageInfo, StatisticWindow.MillisPerTick> mspt = this.getSpark().mspt();
if (mspt == null) this.setValue(0, 0, 0);
else this.setValue(
mspt.poll(StatisticWindow.MillisPerTick.MINUTES_1).min(),
mspt.poll(StatisticWindow.MillisPerTick.MINUTES_1).mean(),
mspt.poll(StatisticWindow.MillisPerTick.MINUTES_1).max()
);
}
private void setValue(double min, double mean, double max) {
this.getGauge().labels("min").set(min);
this.getGauge().labels("mean").set(mean);
this.getGauge().labels("max").set(max);
}
}

View file

@ -1,7 +1,8 @@
package ru.ruscalworld.fabricexporter.metrics;
package ru.ruscalworld.fabricexporter.metrics.spark;
import me.lucko.spark.api.Spark;
import me.lucko.spark.api.SparkProvider;
import ru.ruscalworld.fabricexporter.metrics.Metric;
public abstract class SparkMetric extends Metric {
public SparkMetric(String name, String help, String... labels) {

View file

@ -1,4 +1,4 @@
package ru.ruscalworld.fabricexporter.metrics;
package ru.ruscalworld.fabricexporter.metrics.spark;
import me.lucko.spark.api.statistic.StatisticWindow;
import me.lucko.spark.api.statistic.types.DoubleStatistic;

View file

@ -1,16 +1,31 @@
package ru.ruscalworld.fabricexporter.metrics;
package ru.ruscalworld.fabricexporter.metrics.world;
import net.minecraft.entity.Entity;
import net.minecraft.entity.EntityType;
import net.minecraft.registry.Registries;
import net.minecraft.server.world.ServerWorld;
import net.minecraft.util.Identifier;
import net.minecraft.util.registry.Registry;
import net.minecraft.util.TypeFilter;
import ru.ruscalworld.fabricexporter.FabricExporter;
import ru.ruscalworld.fabricexporter.metrics.Metric;
import ru.ruscalworld.fabricexporter.util.TextUtil;
import java.util.HashMap;
public class Entities extends Metric {
private static final TypeFilter<Entity, ?> ENTITY_FILTER = new TypeFilter<>() {
@Override
public Entity downcast(Entity entity) {
return entity;
}
@Override
public Class<? extends Entity> getBaseClass() {
return Entity.class;
}
};
public Entities() {
super("entities", "Amount of entities in the world", "world", "group", "type");
}
@ -20,15 +35,15 @@ public class Entities extends Metric {
for (ServerWorld world : exporter.getServer().getWorlds()) {
HashMap<String, Integer> currentWorldEntities = new HashMap<>();
for (Entity entity : world.getEntitiesByType(null, entity -> true)) {
String name = Registry.ENTITY_TYPE.getId(entity.getType()).getPath();
world.getEntitiesByType(ENTITY_FILTER, (entity) -> true).forEach(entity -> {
String name = Registries.ENTITY_TYPE.getId(entity.getType()).getPath();
Integer typeCount = currentWorldEntities.getOrDefault(name, 0);
currentWorldEntities.put(name, typeCount + 1);
}
});
for (String type : currentWorldEntities.keySet()) {
Integer count = currentWorldEntities.get(type);
EntityType<?> entityType = Registry.ENTITY_TYPE.get(new Identifier(type));
EntityType<?> entityType = Registries.ENTITY_TYPE.get(new Identifier(type));
this.getGauge().labels(TextUtil.getWorldName(world), entityType.getSpawnGroup().getName(), type).set(count);
}
}

View file

@ -1,7 +1,8 @@
package ru.ruscalworld.fabricexporter.metrics;
package ru.ruscalworld.fabricexporter.metrics.world;
import net.minecraft.server.world.ServerWorld;
import ru.ruscalworld.fabricexporter.FabricExporter;
import ru.ruscalworld.fabricexporter.metrics.Metric;
import ru.ruscalworld.fabricexporter.util.TextUtil;
public class LoadedChunks extends Metric {

View file

@ -1,7 +1,8 @@
package ru.ruscalworld.fabricexporter.metrics;
package ru.ruscalworld.fabricexporter.metrics.world;
import net.minecraft.server.world.ServerWorld;
import ru.ruscalworld.fabricexporter.FabricExporter;
import ru.ruscalworld.fabricexporter.metrics.Metric;
import ru.ruscalworld.fabricexporter.util.TextUtil;
public class OnlinePlayers extends Metric {

View file

@ -1,7 +1,8 @@
package ru.ruscalworld.fabricexporter.metrics;
package ru.ruscalworld.fabricexporter.metrics.world;
import net.minecraft.server.world.ServerWorld;
import ru.ruscalworld.fabricexporter.FabricExporter;
import ru.ruscalworld.fabricexporter.metrics.Metric;
import ru.ruscalworld.fabricexporter.util.TextUtil;
public class TotalLoadedChunks extends Metric {

View file

@ -1,4 +1,4 @@
# On which port webserver should be started?
# On which port Prometheus webserver should be started?
# Default: 25585
server-port=25585
@ -14,8 +14,13 @@ update-interval=1000
# Default: true
use-spark=true
# Should FabricExporter register default Hotspot exports?
# This enables advanced metrics for JVM
# Default: true
export-default-jvm-metrics=true
# You can disable any metric that registered via MetricRegistry (all metrics by default) using the settings below
# Names of properties consist of "enabled" and metric name without prefix and "_" replaced with "-"
# Names of properties consist of "enable" and metric name without prefix and "_" replaced with "-"
# For example, if you want to disable "minecraft_players_online", you should set "enable-players-online" to "false"
# If you can't find property for some metrics, you can manually add it
# All metrics are enabled by default
@ -46,4 +51,4 @@ enable-entities=true
# Exports count of handshake requests
# Collected by FabricExporter
enable-handshakes=true
enable-handshakes=true

View file

@ -21,7 +21,8 @@
"fabricexporter.mixins.json"
],
"depends": {
"fabricloader": ">=0.11.3",
"fabricloader": ">=0.14.13",
"minecraft": ">=1.20.1",
"fabric": "*"
},
"recommends": {