Skip to content

Commit 5fb5493

Browse files
authored
fix(docs): improve real-time monitoring faq (#1050)
2 parents 5d6852f + 40ba82e commit 5fb5493

File tree

1 file changed

+31
-3
lines changed

1 file changed

+31
-3
lines changed

docs/run-node/5-flare-entity.mdx

Lines changed: 31 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -980,10 +980,38 @@ To opt-out of receiving all future FlareDrops, you need to call the [`optOutOfAi
980980
</details>
981981

982982
<details>
983-
<summary>F6. How do I get real-time Slack/Discord/Telegram alerts for my Flare Entity?</summary>
983+
<summary>F6. How do I get real-time Slack/Discord/Telegram alerts for issues with my Flare Entity?</summary>
984984

985-
Try out the alpha version of the [flare-foundation/fsp-observer](https://github.com/flare-foundation/fsp-observer) to receive instant notifications about critical misbehaviors - like FTSO or FDC reveal offenses, registration failures, and more - that could cost rewards.
985+
To receive instant notifications about critical validator or data provider issues - such as FTSO or FDC reveal offenses, registration failures, and more - use the [flare-foundation/fsp-observer](https://github.com/flare-foundation/fsp-observer) monitoring service.
986986

987-
We would appreciate feature requests to direct development of the tool, please raise them on the [issues page](https://github.com/flare-foundation/fsp-observer/issues).
987+
1. Create a env file (e.g., `.env.fsp-observer`) with your configuration:
988+
989+
```plaintext title=".env.fsp-observer"
990+
# Required
991+
RPC_BASE_URL="https://flare-api.flare.network" # Flare RPC endpoint
992+
IDENTITY_ADDRESS="0x0000000000000000000000000000000000000000" # your identity address
993+
994+
# Optional notification channels
995+
NOTIFICATION_DISCORD_WEBHOOK="https://discord.com/api/webhooks/..."
996+
NOTIFICATION_TELEGRAM_BOT_TOKEN="your-telegram-bot-token"
997+
NOTIFICATION_TELEGRAM_CHAT_ID="your-telegram-chat-id"
998+
NOTIFICATION_SLACK_WEBHOOK="https://hooks.slack.com/services/..."
999+
NOTIFICATION_GENERIC_WEBHOOK="http://host:port/path" # generic POST webhook
1000+
```
1001+
1002+
:::warning
1003+
1004+
Make sure this env file is **not committed** to version control (add it to `.gitignore` if needed).
1005+
1006+
:::
1007+
1008+
2. Run the observer using Docker:
1009+
1010+
```bash
1011+
docker run --env-file .env.fsp-observer ghcr.io/flare-foundation/fsp-observer:main
1012+
```
1013+
1014+
The container will watch your identity and send notifications to any configured channels when issues are detected.
1015+
If you encounter problems or have feature requests, open an issue on the [GitHub issues page](https://github.com/flare-foundation/fsp-observer/issues).
9881016

9891017
</details>

0 commit comments

Comments
 (0)