| 1 | plugin_name: go.d.plugin |
| 2 | modules: |
| 3 | - meta: |
| 4 | id: collector-go.d.plugin-spigotmc |
| 5 | plugin_name: go.d.plugin |
| 6 | module_name: spigotmc |
| 7 | monitored_instance: |
| 8 | name: SpigotMC |
| 9 | link: https://www.spigotmc.org/ |
| 10 | categories: |
| 11 | - data-collection.applications |
| 12 | icon_filename: "spigot.jfif" |
| 13 | related_resources: |
| 14 | integrations: |
| 15 | list: [] |
| 16 | info_provided_to_referring_integrations: |
| 17 | description: "" |
| 18 | keywords: |
| 19 | - minecraft |
| 20 | - spigotmc |
| 21 | - spigot |
| 22 | overview: |
| 23 | data_collection: |
| 24 | metrics_description: | |
| 25 | This collector monitors SpigotMC server server performance, in the form of ticks per second average, memory utilization, and active users. |
| 26 | method_description: | |
| 27 | It sends the `tps` and `list` commands to the Server, and gathers the metrics from the responses. |
| 28 | supported_platforms: |
| 29 | include: [] |
| 30 | exclude: [] |
| 31 | multi_instance: true |
| 32 | additional_permissions: |
| 33 | description: "" |
| 34 | default_behavior: |
| 35 | auto_detection: |
| 36 | description: | |
| 37 | By default, it detects SpigotMC instances running on localhost that are listening on port 25575. |
| 38 | |
| 39 | > **Note that the SpigotMC RCON API requires a password**. |
| 40 | > While Netdata can automatically detect SpigotMC instances and create data collection jobs, these jobs will fail unless you provide the necessary credentials. |
| 41 | limits: |
| 42 | description: "" |
| 43 | performance_impact: |
| 44 | description: "" |
| 45 | setup: |
| 46 | prerequisites: |
| 47 | list: [] |
| 48 | configuration: |
| 49 | file: |
| 50 | name: go.d/spigotmc.conf |
| 51 | options: |
| 52 | description: | |
| 53 | The following options can be defined globally: update_every, autodetection_retry. |
| 54 | folding: |
| 55 | title: Config options |
| 56 | enabled: true |
| 57 | list: |
| 58 | - name: update_every |
| 59 | description: Data collection frequency (seconds). |
| 60 | default_value: 1 |
| 61 | required: false |
| 62 | group: Collection |
| 63 | - name: autodetection_retry |
| 64 | description: Autodetection retry interval (seconds). Set 0 to disable. |
| 65 | default_value: 0 |
| 66 | required: false |
| 67 | group: Collection |
| 68 | |
| 69 | - name: address |
| 70 | description: SpigotMC server RCON address (IP:PORT). |
| 71 | default_value: 127.0.0.1:25575 |
| 72 | required: true |
| 73 | group: Target |
| 74 | - name: timeout |
| 75 | description: Connection, read, and write timeout duration (seconds). Includes name resolution. |
| 76 | default_value: 1 |
| 77 | required: false |
| 78 | group: Target |
| 79 | |
| 80 | - name: password |
| 81 | description: RCON password for authentication. |
| 82 | default_value: "" |
| 83 | required: true |
| 84 | group: Auth |
| 85 | |
| 86 | - name: vnode |
| 87 | description: Associates this data collection job with a [Virtual Node](https://learn.netdata.cloud/docs/netdata-agent/configuration/organize-systems-metrics-and-alerts#virtual-nodes). |
| 88 | default_value: "" |
| 89 | required: false |
| 90 | group: Virtual Node |
| 91 | examples: |
| 92 | folding: |
| 93 | enabled: true |
| 94 | title: Config |
| 95 | list: |
| 96 | - name: Basic |
| 97 | description: A basic example configuration. |
| 98 | config: | |
| 99 | jobs: |
| 100 | - name: local |
| 101 | address: 127.0.0.1:25575 |
| 102 | password: somePassword |
| 103 | - name: Multi-instance |
| 104 | description: | |
| 105 | > **Note**: When you define multiple jobs, their names must be unique. |
| 106 | |
| 107 | Collecting metrics from local and remote instances. |
| 108 | config: | |
| 109 | jobs: |
| 110 | - name: local |
| 111 | address: 127.0.0.1:25575 |
| 112 | password: somePassword |
| 113 | |
| 114 | - name: remote |
| 115 | address: 203.0.113.0:25575 |
| 116 | password: somePassword |
| 117 | troubleshooting: |
| 118 | problems: |
| 119 | list: [] |
| 120 | alerts: [] |
| 121 | metrics: |
| 122 | folding: |
| 123 | title: Metrics |
| 124 | enabled: false |
| 125 | description: "" |
| 126 | availability: [] |
| 127 | scopes: |
| 128 | - name: global |
| 129 | description: "These metrics refer to the entire monitored application." |
| 130 | labels: [] |
| 131 | metrics: |
| 132 | - name: spigotmc.players |
| 133 | description: Active Players |
| 134 | unit: "players" |
| 135 | chart_type: line |
| 136 | dimensions: |
| 137 | - name: players |
| 138 | - name: spigotmc.avg_tps |
| 139 | description: Average Ticks Per Second |
| 140 | unit: "ticks" |
| 141 | chart_type: line |
| 142 | dimensions: |
| 143 | - name: 1min |
| 144 | - name: 5min |
| 145 | - name: 15min |
| 146 | - name: spigotmc.memory |
| 147 | description: Memory Usage |
| 148 | unit: "bytes" |
| 149 | chart_type: area |
| 150 | dimensions: |
| 151 | - name: used |
| 152 | - name: alloc |