okooooooo/bililive-go
1
0 Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Setup grafana automatically (#520)

Browse Source 
* Setup grafana automatically

* Grafana documents

* Premissions

* Manual install

* Guide for environment file

* Set homepage

>能不能通过修改配置，让 bililive-go 的 dashboard 默认在 grafana 的首页展示呢？
设置默认主页

* Replace dashboard

Move dashboard to contrib

---------

Co-authored-by: kuri <kurikuri22@yandex.com>
This commit is contained in:
liwufanandkuri authored and kira1928 committed 2023-11-25 17:38:28 +09:00
1 parent 508219f201
commit 1cd7af3875
9 files changed
+552
Download Patch File Download Diff File Expand all files Collapse all files

No files matched your search

README.md
+3
View File
@@ -154,6 +154,9 @@ cookies:
![image](https://github.com/hr3lxphr6j/bililive-go/raw/master/docs/dashboard.webp)
增加说明
[grafana](docs/grafana.md)
## 依赖
* [ffmpeg](https://ffmpeg.org/)
dashbord.json → contrib/grafana/dashboard.json
View File
File renamed without changes.
contrib/grafana/provisioning/dashboards/bilipanel.json
+415
View File
@@ -0,0 +1,415 @@
{
"annotations": {
"list": [
{
"builtIn": 1,
"datasource": {
"type": "datasource",
"uid": "grafana"
},
"enable": true,
"hide": true,
"iconColor": "rgba(0, 211, 255, 1)",
"name": "Annotations & Alerts",
"target": {
"limit": 100,
"matchAny": false,
"tags": [],
"type": "dashboard"
},
"type": "dashboard"
}
]
},
"editable": true,
"fiscalYearStartMonth": 0,
"graphTooltip": 0,
"id": 2,
"links": [],
"liveNow": false,
"panels": [
{
"datasource": {
"type": "prometheus",
"uid": "PBFA97CFB590B2093"
},
"fieldConfig": {
"defaults": {
"color": {
"mode": "thresholds"
},
"mappings": [
{
"options": {
"0": {
"color": "yellow",
"index": 1,
"text": "摸"
},
"1": {
"color": "green",
"index": 0,
"text": "播"
}
},
"type": "value"
}
],
"thresholds": {
"mode": "absolute",
"steps": [
{
"color": "green",
"value": null
}
]
}
},
"overrides": []
},
"gridPos": {
"h": 10,
"w": 8,
"x": 0,
"y": 0
},
"hideTimeOverride": true,
"id": 2,
"options": {
"colorMode": "value",
"graphMode": "none",
"justifyMode": "center",
"orientation": "auto",
"reduceOptions": {
"calcs": [
"lastNotNull"
],
"fields": "",
"values": false
},
"text": {},
"textMode": "value_and_name"
},
"pluginVersion": "10.0.3",
"targets": [
{
"datasource": {
"type": "prometheus",
"uid": "PBFA97CFB590B2093"
},
"exemplar": true,
"expr": "bgo_live_status{instance=~\"$instance\", live_host_name=~\"$anchor\"}",
"instant": true,
"interval": "",
"legendFormat": "{{live_host_name}}",
"refId": "A"
}
],
"timeFrom": "1m",
"title": "Live Status",
"type": "stat"
},
{
"datasource": {
"type": "prometheus",
"uid": "PBFA97CFB590B2093"
},
"fieldConfig": {
"defaults": {
"color": {
"mode": "thresholds"
},
"mappings": [],
"thresholds": {
"mode": "absolute",
"steps": [
{
"color": "green",
"value": null
}
]
},
"unit": "s"
},
"overrides": []
},
"gridPos": {
"h": 10,
"w": 16,
"x": 8,
"y": 0
},
"hideTimeOverride": true,
"id": 8,
"interval": "1m",
"options": {
"colorMode": "value",
"graphMode": "area",
"justifyMode": "auto",
"orientation": "auto",
"reduceOptions": {
"calcs": [
"lastNotNull"
],
"fields": "",
"values": false
},
"text": {},
"textMode": "value_and_name"
},
"pluginVersion": "10.0.3",
"targets": [
{
"datasource": {
"type": "prometheus",
"uid": "PBFA97CFB590B2093"
},
"exemplar": false,
"expr": "sum by(live_host_name)(increase(bgo_live_duration_seconds{instance=~\"$instance\", live_host_name=~\"$anchor\"}[30d]))",
"interval": "",
"legendFormat": "{{live_host_name}}",
"refId": "A"
}
],
"timeFrom": "30d",
"title": "Length of live stream in the past 30 days",
"type": "stat"
},
{
"datasource": {
"type": "prometheus",
"uid": "PBFA97CFB590B2093"
},
"fieldConfig": {
"defaults": {
"color": {
"mode": "thresholds"
},
"mappings": [],
"thresholds": {
"mode": "absolute",
"steps": [
{
"color": "green",
"value": null
}
]
},
"unit": "decbytes"
},
"overrides": []
},
"gridPos": {
"h": 12,
"w": 3,
"x": 0,
"y": 10
},
"hideTimeOverride": true,
"id": 6,
"options": {
"colorMode": "value",
"graphMode": "none",
"justifyMode": "auto",
"orientation": "horizontal",
"reduceOptions": {
"calcs": [
"lastNotNull"
],
"fields": "",
"values": false
},
"text": {},
"textMode": "value_and_name"
},
"pluginVersion": "10.0.3",
"targets": [
{
"datasource": {
"type": "prometheus",
"uid": "PBFA97CFB590B2093"
},
"exemplar": true,
"expr": "bgo_recorder_total_bytes{instance=~\"$instance\", live_host_name=~\"$anchor\"}",
"format": "time_series",
"instant": true,
"interval": "",
"legendFormat": "{{live_host_name}}",
"refId": "A"
}
],
"title": "Output File Size",
"type": "stat"
},
{
"datasource": {
"type": "prometheus",
"uid": "PBFA97CFB590B2093"
},
"description": "",
"fieldConfig": {
"defaults": {
"color": {
"mode": "palette-classic"
},
"custom": {
"axisCenteredZero": false,
"axisColorMode": "text",
"axisLabel": "",
"axisPlacement": "auto",
"barAlignment": 0,
"drawStyle": "line",
"fillOpacity": 0,
"gradientMode": "none",
"hideFrom": {
"legend": false,
"tooltip": false,
"viz": false
},
"lineInterpolation": "linear",
"lineWidth": 1,
"pointSize": 5,
"scaleDistribution": {
"type": "linear"
},
"showPoints": "never",
"spanNulls": true,
"stacking": {
"group": "A",
"mode": "none"
},
"thresholdsStyle": {
"mode": "off"
}
},
"mappings": [],
"thresholds": {
"mode": "absolute",
"steps": [
{
"color": "green",
"value": null
}
]
},
"unit": "Bps"
},
"overrides": []
},
"gridPos": {
"h": 12,
"w": 21,
"x": 3,
"y": 10
},
"hideTimeOverride": false,
"id": 4,
"options": {
"legend": {
"calcs": [],
"displayMode": "list",
"placement": "bottom",
"showLegend": true
},
"tooltip": {
"mode": "single",
"sort": "none"
}
},
"pluginVersion": "8.2.0",
"targets": [
{
"datasource": {
"type": "prometheus",
"uid": "PBFA97CFB590B2093"
},
"exemplar": true,
"expr": "irate(bgo_recorder_total_bytes{instance=~\"$instance\", live_host_name=~\"$anchor\"}[$__interval])",
"format": "time_series",
"instant": false,
"interval": "",
"intervalFactor": 1,
"legendFormat": "{{live_host_name}}",
"refId": "A"
}
],
"title": "Live Bitrate",
"type": "timeseries"
}
],
"refresh": "10s",
"schemaVersion": 38,
"style": "dark",
"tags": [],
"templating": {
"list": [
{
"allValue": ".*",
"current": {
"selected": false,
"text": "All",
"value": "$__all"
},
"datasource": {
"type": "prometheus",
"uid": "PBFA97CFB590B2093"
},
"definition": "bgo_live_status",
"description": "bililive instance name",
"hide": 0,
"includeAll": true,
"multi": true,
"name": "instance",
"options": [],
"query": {
"query": "bgo_live_status",
"refId": "StandardVariableQuery"
},
"refresh": 2,
"regex": "/instance=\"(.*?)\"/",
"skipUrlSync": false,
"sort": 0,
"type": "query"
},
{
"allValue": ".*",
"current": {
"selected": false,
"text": "All",
"value": "$__all"
},
"datasource": {
"type": "prometheus",
"uid": "PBFA97CFB590B2093"
},
"definition": "bgo_live_status",
"description": "anchor name",
"hide": 0,
"includeAll": true,
"label": "",
"multi": true,
"name": "anchor",
"options": [],
"query": {
"query": "bgo_live_status",
"refId": "StandardVariableQuery"
},
"refresh": 2,
"regex": "/live_host_name=\"(.*?)\"/",
"skipUrlSync": false,
"sort": 0,
"type": "query"
}
]
},
"time": {
"from": "now-30m",
"to": "now"
},
"timepicker": {},
"timezone": "",
"title": "Bililive Dashboards",
"uid": "iXqlPlBnkp",
"version": 1,
"weekStart": ""
}
contrib/grafana/provisioning/dashboards/dashboard.yml
+12
View File
@@ -0,0 +1,12 @@
apiVersion: 1
providers:
- name: 'Prometheus'
orgId: 1
folder: ''
type: file
disableDeletion: false
editable: true
allowUiUpdates: true
options:
path: /etc/grafana/provisioning/dashboards
contrib/grafana/provisioning/datasources/datasource.yml
+11
View File
@@ -0,0 +1,11 @@
apiVersion: 1
datasources:
- name: Prometheus
type: prometheus
access: proxy
orgId: 1
url: http://prometheus:9090
basicAuth: false
isDefault: true
editable: true
contrib/prometheus/prometheus.yml
+25
View File
@@ -0,0 +1,25 @@
# my global config
global:
scrape_interval: 15s # Set the scrape interval to every 15 seconds. Default is every 1 minute.
evaluation_interval: 15s # Evaluate rules every 15 seconds. The default is every 1 minute.
# Alertmanager configuration
alerting:
alertmanagers:
- static_configs:
- targets:
# - alertmanager:9093
# Load rules once and periodically evaluate them according to the global 'evaluation_interval'.
rule_files:
# - "first_rules.yml"
# - "second_rules.yml"
# A scrape configuration containing exactly one endpoint to scrape:
# Here it's Prometheus itself.
scrape_configs:
# The job name is added as a label `job=<job_name>` to any timeseries scraped from this config.
- job_name: "bililive"
static_configs:
- targets: ["bililive-go:8080"]
metrics_path: "/api/metrics"
docker-compose.yml
+44
View File
@@ -0,0 +1,44 @@
version: "3.7"
volumes:
prometheus_data: {}
services:
bililive-go:
image: chigusa/bililive-go
restart: unless-stopped
container_name: bililive-go
volumes:
- ./Videos:/srv/bililive
ports:
- 8080:8080
prometheus:
image: quay.io/prometheus/prometheus
restart: unless-stopped
container_name: bililive-prom
volumes:
- prometheus_data:/prometheus
- ./contrib/prometheus:/etc/prometheus
command:
# retention 建议大于30天
- '--storage.tsdb.retention.time=30d'
- '--config.file=/etc/prometheus/prometheus.yml'
- '--storage.tsdb.path=/prometheus'
- '--web.console.libraries=/usr/share/prometheus/console_libraries'
- '--web.console.templates=/usr/share/prometheus/consoles'
ports:
- 9090:9090
grafana:
image: grafana/grafana-oss
restart: unless-stopped
container_name: bililive-graf
volumes:
- ./contrib/grafana/provisioning:/etc/grafana/provisioning
environment:
- GF_SECURITY_ADMIN_USER=${ADMIN_USER}
- GF_SECURITY_ADMIN_PASSWORD=${ADMIN_PASSWORD}
- GF_USERS_ALLOW_SIGN_UP=false
- GF_DASHBOARDS_DEFAULT_HOME_DASHBOARD_PATH=/etc/grafana/provisioning/dashboards/bilipanel.json
ports:
- 3000:3000
docs/grafana.md
+40
View File
@@ -0,0 +1,40 @@
# 三合一简化安装，原本的文档太晦涩了。
## 安装
1. clone repo
>$ git clone https://github.com/hr3lxphr6j/bililive-go.git
2. 编辑 .env
自定义账户密码，将example.env保存为.env
默认账户密码 `admin admin`
不改网页里也会提醒你去改。
3. 命令行输入
>$ docker compose up
假如docker 版本低于20，需要安装docker-compose。新的版本是直接内置的
4. 浏览器打开 http://localhost:3000 。
tips
- 使用默认端口和别的端口冲突时，修改相关ports:
- `./Videos:/srv/bililive` 默认保存路径需要自定义
bibliography
1. [Docker-Compose-Prometheus-and-Grafana](https://github.com/Einsteinish/Docker-Compose-Prometheus-and-Grafana)
# 手动安装笔记
没有 docker 或者想在其他机器配置监控也可以选择手动安装。
虽然API.md里面没有写，但是路径应该是`/api/metrics` 。`prometheus.yml` 需要写成以下形式
``` yml
global:
scrape_interval: 15s
scrape_configs:
- job_name: "bililive"
metrics_path: "/api/metrics"
scheme: http
static_configs:
- targets: ["bililive-go:8080"] #自行修改ip端口
```
grafana 需要打开浏览器，然后复制[面板内容](/contrib/grafana/dashboard.json)导入
example.env
+2
View File
@@ -0,0 +1,2 @@
ADMIN_USER=admin
ADMIN_PASSWORD=admin