📦 yoshinorin / gitbucket-monitoring-plugin

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69# gitbucket-monitoring-plugin

[![build](https://github.com/yoshinorin/gitbucket-monitoring-plugin/workflows/build/badge.svg?branch=master)](https://github.com/yoshinorin/gitbucket-monitoring-plugin/actions)

# Features

This plugin provides monitoring page which contains machine information, resources, processes, and Java information for [GitBucket](//github.com/gitbucket/gitbucket) Administrator.

All viewable informations are below.

* Operating System Information (OS, Distribution, Version, Architecture)
* Uptime (When booted, Spent time after booted)
* Time (Current Time, Time Zone, Zone offset, Day of Week)
* Environment variables
* Resources (Cpu Cores, Cpu Statistics, Physical memory, Swap, Disk Usage)
* Load average
* Tasks (Running, Sleeping, Stopped, Zombie)
* Java system properties and memory
* **(Obsolete)** ~~LogBack settings~~ Please use [gitbucket-application-logs-plugin](https://github.com/yoshinorin/gitbucket-application-logs-plugin).
* **(Obsolete)** ~~GitBucket's log~~ Please use [gitbucket-application-logs-plugin](https://github.com/yoshinorin/gitbucket-application-logs-plugin).

# Images

||||
|:-------:|:-------:|:-------:|
|![menu](https://raw.githubusercontent.com/yoshinorin/gitbucket-monitoring-plugin/master/doc/images/menu.png)|![system](https://raw.githubusercontent.com/yoshinorin/gitbucket-monitoring-plugin/master/doc/images/system.png)|![envval](https://raw.githubusercontent.com/yoshinorin/gitbucket-monitoring-plugin/master/doc/images/envval.png)|
|![resources](https://raw.githubusercontent.com/yoshinorin/gitbucket-monitoring-plugin/master//doc/images/resources.png)|![linux-cpu](https://raw.githubusercontent.com/yoshinorin/gitbucket-monitoring-plugin/master/doc/images/linux-cpus.png)|![process](https://raw.githubusercontent.com/yoshinorin/gitbucket-monitoring-plugin/master/doc/images/process.png)|
|![java-p](https://raw.githubusercontent.com/yoshinorin/gitbucket-monitoring-plugin/master/doc/images/java-p.png)|![java-m](https://raw.githubusercontent.com/yoshinorin/gitbucket-monitoring-plugin/master/doc/images/java-m.png)||

# Download & Installation

1. Download plugin jar file from [the release page](//github.com/yoshinorin/gitbucket-monitoring-plugin/releases).
2. Put plugin jar file into `GITBUCKET_HOME/plugins` and restart GitBucket.

# UI Usage

Goto the `System Administration` menu, you can see `Monitoring` section.

# Compatibility with GitBucket

|Plugin version|GitBucket version|
|:-------------:|:-------:|
|5.1.x|4.37.0 - |
|5.0.x|4.35.0 - 4.36.x|
|4.0.x|4.32.0 - 4.34.0|
|3.2.0|4.25.0 - 4.31.x|
|3.1.0|4.25.0 - 4.31.x|
|3.0.0|4.25.0 - 4.31.x|
|2.0.0|4.23 - 4.25.0|
|1.2.0|4.10 - 4.22.0|
|1.1.0|4.10 - 4.21.x|
|1.0.0|4.10 - 4.21.x|

# Supported OS

I confirm work it only `Debian GNU/Linux 8`, `Ubuntu 16.04` and `Windows10`.  But I think maybe also will be work it on other distribution(version) of Linux and Window. Mac is also.

# Build from source

```sh
sbt assembly
```

The built package will be created at `/target/scala-2.13/gitbucket-monitorting-plugin{plugin-version}.jar`

# License

This project is under the Apache License, Version 2.0 License. See the [LICENSE](./LICENSE) file for the full license text.