Skip to content

Commit a2cee4a

Browse files
author
Торопов Алексей Викторович
committed
Initial release v1.0.0
0 parents  commit a2cee4a

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

50 files changed

+21513
-0
lines changed

‎.eslintrc‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
{
2+
"extends": "./.config/.eslintrc"
3+
}

‎.github/workflows/release.yml‎

Lines changed: 78 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,78 @@
1+
name: Release
2+
3+
on:
4+
push:
5+
tags:
6+
- 'v*.*.*'
7+
8+
permissions:
9+
contents: write
10+
11+
jobs:
12+
release:
13+
runs-on: ubuntu-latest
14+
15+
steps:
16+
- name: Checkout
17+
uses: actions/checkout@v4
18+
19+
- name: Setup Node.js
20+
uses: actions/setup-node@v4
21+
with:
22+
node-version: '22'
23+
cache: 'npm'
24+
25+
- name: Install dependencies
26+
run: npm ci
27+
28+
- name: Build plugin
29+
run: npm run build
30+
31+
- name: Sign plugin
32+
run: npx @grafana/sign-plugin@latest
33+
env:
34+
GRAFANA_ACCESS_POLICY_TOKEN: ${{ secrets.GRAFANA_ACCESS_POLICY_TOKEN }}
35+
# Remove this step until you receive a signing token from Grafana.
36+
# The build will still work — the plugin just won't be signed yet.
37+
continue-on-error: true
38+
39+
- name: Get plugin metadata
40+
id: metadata
41+
run: |
42+
PLUGIN_ID=$(cat dist/plugin.json | jq -r .id)
43+
PLUGIN_VERSION=$(cat dist/plugin.json | jq -r .info.version)
44+
ARCHIVE_NAME="${PLUGIN_ID}-${PLUGIN_VERSION}.zip"
45+
echo "plugin-id=${PLUGIN_ID}" >> $GITHUB_OUTPUT
46+
echo "plugin-version=${PLUGIN_VERSION}" >> $GITHUB_OUTPUT
47+
echo "archive=${ARCHIVE_NAME}" >> $GITHUB_OUTPUT
48+
49+
- name: Package plugin
50+
run: |
51+
mv dist ${{ steps.metadata.outputs.plugin-id }}
52+
zip -r ${{ steps.metadata.outputs.archive }} \
53+
${{ steps.metadata.outputs.plugin-id }} \
54+
--exclude "*.git*"
55+
56+
- name: Calculate SHA1
57+
id: sha1
58+
run: |
59+
SHA1=$(sha1sum ${{ steps.metadata.outputs.archive }} | awk '{print $1}')
60+
echo "sha1=${SHA1}" >> $GITHUB_OUTPUT
61+
62+
- name: Create GitHub Release
63+
uses: softprops/action-gh-release@v2
64+
with:
65+
files: ${{ steps.metadata.outputs.archive }}
66+
body: |
67+
## ${{ steps.metadata.outputs.plugin-id }} v${{ steps.metadata.outputs.plugin-version }}
68+
69+
### Installation
70+
Download the zip archive below and extract it into your Grafana plugins directory.
71+
72+
```bash
73+
unzip ${{ steps.metadata.outputs.archive }} -d /var/lib/grafana/plugins/
74+
```
75+
76+
**SHA1:** `${{ steps.sha1.outputs.sha1 }}`
77+
78+
See [README](https://github.com/${{ github.repository }}#installation) for full installation instructions.

‎.gitignore‎

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
node_modules/
2+
.config/
3+
dist/
4+
.cache/
5+
.yarn/
6+
*.js.map
7+
8+
# OS
9+
.DS_Store
10+
Thumbs.db
11+
12+
# IDE
13+
.vscode/
14+
.idea/
15+
16+
# Environment
17+
.env
18+
.env.local
19+
20+
# Grafana dev environment
21+
docker-compose.override.yml

‎.nvmrc‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
22

‎.prettierrc.js‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
module.exports = {
2+
...require('./.config/.prettierrc.js'),
3+
};

‎CHANGELOG.md‎

Lines changed: 56 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,56 @@
1+
# Changelog
2+
3+
All notable changes to this project will be documented in this file.
4+
5+
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/).
6+
7+
---
8+
9+
## [1.0.0] — 2025-02-24
10+
11+
### ✨ Added — Complete rewrite for Grafana 10+
12+
13+
This is a full rewrite of the abandoned `serrrios-statusoverview-panel-2` plugin with no shared code.
14+
15+
#### Visual
16+
- Status levels: OK, Information, Warning, Average, High, Disaster, Disabled, N/A
17+
- Blink animation on status change with configurable duration (5–60 seconds)
18+
- Colorize each metric individually by its own status color
19+
- Configurable corner radius (0–50 px)
20+
- Icon support: None / Built-in Grafana icons / Custom URL image
21+
- Tag label in the top-left corner
22+
- Timestamp of last status change in the top-right corner (Time / Date+Time / Relative)
23+
- Panel link URL with Grafana variable support
24+
- Custom text color with auto-contrast fallback
25+
- Separate font size controls for title and metrics
26+
27+
#### Sound
28+
- 5 built-in alert tones via Web Audio API (one per severity level)
29+
- Custom audio URL (MP3/OGG) per status level
30+
- Per-status mode: Off / Built-in / Custom URL
31+
- Master volume slider (0–100%)
32+
- Preview button for each sound in settings
33+
34+
#### Rules
35+
- Regex metric matching with real-time validation and error highlighting
36+
- Number threshold, String threshold, and Show-only display modes
37+
- Reverse logic (trigger when value ≤ threshold)
38+
- Drag & drop rule reordering via `@dnd-kit`
39+
- Duplicate rule with one click
40+
- Export / Import rules to/from JSON
41+
- Search filter (appears when more than 3 rules)
42+
- Metric URL per rule (click metric name to open URL)
43+
- Description tooltip on hover
44+
45+
#### Reliability
46+
- Switch to N/A on data source error (prevents false-green status)
47+
- Custom error message when data source fails
48+
- No flicker during Grafana refresh cycles
49+
50+
#### Developer
51+
- Full TypeScript rewrite with strict typing
52+
- Separated hooks: `useStatusTransition`, `useAlertSound`
53+
- Unit tests for `colorResolver`, `comparisonFunctions`, `displayBuilder`, `statusResolver`
54+
55+
#### Migration
56+
- `migrate_panel.py` — Python script for automated migration of existing dashboards from the old plugin format

‎LICENSE‎

Lines changed: 182 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,182 @@
1+
Apache License
2+
Version 2.0, January 2004
3+
http://www.apache.org/licenses/
4+
5+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
6+
7+
1. Definitions.
8+
9+
"License" shall mean the terms and conditions for use, reproduction,
10+
and distribution as defined by Sections 1 through 9 of this document.
11+
12+
"Licensor" shall mean the copyright owner or entity authorized by
13+
the copyright owner that is granting the License.
14+
15+
"Legal Entity" shall mean the union of the acting entity and all
16+
other entities that control, are controlled by, or are under common
17+
control with that entity. For the purposes of this definition,
18+
"control" means (i) the power, direct or indirect, to cause the
19+
direction or management of such entity, whether by contract or
20+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
21+
outstanding shares, or (iii) beneficial ownership of such entity.
22+
23+
"You" (or "Your") shall mean an individual or Legal Entity
24+
exercising permissions granted by this License.
25+
26+
"Source" form shall mean the preferred form for making modifications,
27+
including but not limited to software source code, documentation
28+
source, and configuration files.
29+
30+
"Object" form shall mean any form resulting from mechanical
31+
transformation or translation of a Source form, including but
32+
not limited to compiled object code, generated documentation,
33+
and conversions to other media types.
34+
35+
"Work" shall mean the work of authorship made available under
36+
the License, as indicated by a copyright notice that is included in
37+
or attached to the work (an example is provided in the Appendix below).
38+
39+
"Derivative Works" shall mean any work, whether in Source or Object
40+
form, that is based on (or derived from) the Work and for which the
41+
editorial revisions, annotations, elaborations, or other transformations
42+
represent, as a whole, an original work of authorship. For the purposes
43+
of this License, Derivative Works shall not include works that remain
44+
separable from, or merely link (or bind by name) to the interfaces of,
45+
the Work and Derivative Works thereof.
46+
47+
"Contribution" shall mean, as submitted to the Licensor for inclusion
48+
in the Work by the copyright owner or by an individual or Legal Entity
49+
authorized to submit on behalf of the copyright owner. For the purposes
50+
of this definition, "submitted" means any form of electronic, verbal,
51+
or written communication sent to the Licensor or its representatives,
52+
including but not limited to communication on electronic mailing lists,
53+
source code control systems, and issue tracking systems that are managed
54+
by, or on behalf of, the Licensor for the purpose of discussing and
55+
improving the Work, but excluding communication that is conspicuously
56+
marked or designated in writing by the copyright owner as "Not a
57+
Contribution."
58+
59+
"Contributor" shall mean Licensor and any Legal Entity on behalf of
60+
whom a Contribution has been received by the Licensor and included
61+
within the Work.
62+
63+
2. Grant of Copyright License. Subject to the terms and conditions of
64+
this License, each Contributor hereby grants to You a perpetual,
65+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
66+
copyright license to reproduce, prepare Derivative Works of,
67+
publicly display, publicly perform, sublicense, and distribute the
68+
Work and such Derivative Works in Source or Object form.
69+
70+
3. Grant of Patent License. Subject to the terms and conditions of
71+
this License, each Contributor hereby grants to You a perpetual,
72+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
73+
(except as stated in this section) patent license to make, have made,
74+
use, offer to sell, sell, import, and otherwise transfer the Work,
75+
where such license applies only to those patent claims licensable
76+
by such Contributor that are necessarily infringed by their
77+
Contribution(s) alone or by the combination of their Contribution(s)
78+
with the Work to which such Contribution(s) was submitted. If You
79+
institute patent litigation against any entity (including a cross-claim
80+
or counterclaim in a lawsuit) alleging that the patent or any
81+
Contribution embodied within the Work constitutes direct or contributory
82+
patent infringement, then any patent licenses granted to You under
83+
this License for that Work shall terminate as of the date such
84+
litigation is filed.
85+
86+
4. Redistribution. You may reproduce and distribute copies of the
87+
Work or Derivative Works thereof in any medium, with or without
88+
modifications, and in Source or Object form, provided that You
89+
meet the following conditions:
90+
91+
(a) You must give any other recipients of the Work or Derivative
92+
Works a copy of this License; and
93+
94+
(b) You must cause any modified files to carry prominent notices
95+
stating that You changed the files; and
96+
97+
(c) You must retain, in the Source form of any Derivative Works
98+
that You distribute, all copyright, patent, trademark, and
99+
attribution notices from the Source form of the Work,
100+
excluding those notices that do not pertain to any part of
101+
the Derivative Works; and
102+
103+
(d) If the Work includes a "NOTICE" text file as part of its
104+
distribution, You must include a readable copy of the
105+
attribution notices contained within such NOTICE file, in
106+
at least one of the following places: within a NOTICE text
107+
file distributed as part of the Derivative Works; within
108+
the Source form or documentation, if provided along with the
109+
Derivative Works; or, within a display generated by the
110+
Derivative Works, if and wherever such third-party notices
111+
normally appear. The contents of the NOTICE file are for
112+
informational purposes only and do not modify the License.
113+
You may add Your own attribution notices within Derivative
114+
Works that You distribute, alongside or in addition to the
115+
NOTICE text from the Work, provided that such additional
116+
attribution notices cannot be construed as modifying the License.
117+
118+
You may add Your own license statement for Your modifications and
119+
may provide additional grant of rights to use, copy, modify, merge,
120+
publish, distribute, sublicense, and/or sell copies of the
121+
Contribution, either on an original or derivative basis.
122+
123+
5. Submission of Contributions. Unless You explicitly state otherwise,
124+
any Contribution intentionally submitted for inclusion in the Work
125+
by You to the Licensor shall be under the terms and conditions of
126+
this License, without any additional terms or conditions.
127+
Notwithstanding the above, nothing herein shall supersede or modify
128+
the terms of any separate license agreement you may have executed
129+
with Licensor regarding such Contributions.
130+
131+
6. Trademarks. This License does not grant permission to use the trade
132+
names, trademarks, service marks, or product names of the Licensor,
133+
except as required for reasonable and customary use in describing the
134+
origin of the Work and reproducing the content of the NOTICE file.
135+
136+
7. Disclaimer of Warranty. Unless required by applicable law or
137+
agreed to in writing, Licensor provides the Work (and each
138+
Contributor provides its Contributions) on an "AS IS" BASIS,
139+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
140+
implied, including, without limitation, any conditions of TITLE,
141+
MERCHANTIBILITY, or FITNESS FOR A PARTICULAR PURPOSE. You are solely
142+
responsible for determining the appropriateness of using or
143+
redistributing the Work and assume any risks associated with Your
144+
exercise of permissions under this License.
145+
146+
8. Limitation of Liability. In no event and under no legal theory,
147+
whether in tort (including negligence), contract, or otherwise,
148+
unless required by applicable law (such as deliberate and grossly
149+
negligent acts) or agreed to in writing, shall any Contributor be
150+
liable to You for damages, including any direct, indirect, special,
151+
incidental, or exemplary damages of any character arising as a
152+
result of this License or out of the use or inability to use the
153+
Work (even if such Contributor has been advised of the possibility
154+
of such damages).
155+
156+
9. Accepting Warranty or Additional Liability. While redistributing
157+
the Work or Derivative Works thereof, You may offer, and charge a
158+
fee for, acceptance of support, warranty, indemnity, or other
159+
liability obligations and/or rights consistent with this License.
160+
However, in accepting such obligations, You may offer such
161+
obligations consistent with these conditions only on Your own behalf
162+
and on Your sole responsibility, not on behalf of any other
163+
Contributor, and only if You agree to indemnify, defend, and hold
164+
each Contributor harmless for any liability incurred by, or claims
165+
asserted against, such Contributor by reason of your accepting any
166+
such warranty or additional liability.
167+
168+
END OF TERMS AND CONDITIONS
169+
170+
Copyright 2026 Aleksey Toropov
171+
172+
Licensed under the Apache License, Version 2.0 (the "License");
173+
you may not use this file except in compliance with the License.
174+
You may obtain a copy of the License at
175+
176+
http://www.apache.org/licenses/LICENSE-2.0
177+
178+
Unless required by applicable law or agreed to in writing, software
179+
distributed under the License is distributed on an "AS IS" BASIS,
180+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
181+
See the License for the specific language governing permissions and
182+
limitations under the License.

0 commit comments

Comments
 (0)