Skip to content

Commit 17d7564

Browse files
committed
update README for alarm logging service
1 parent 9445235 commit 17d7564

File tree

1 file changed

+8
-2
lines changed

1 file changed

+8
-2
lines changed

services/alarm-logger/README.md

Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
1-
# Alarm Logging
1+
# Alarm Logging Service
22

3-
Logging alarm state and other messages to an elastic back end.
3+
The alarm logging service (aka alarm-logger) records all alarm messages to create an archive of all alarm state changes and the associated actions.
4+
This is an elasticsearch back end.
45

56
## Dependencies ##
67
1. Elasticsearch version 8.x OS specific release can be found here:
@@ -48,6 +49,11 @@ mvn spring-boot:run
4849
Run with `-help` to see command line options,
4950
including those used to create daily, weekly or monthly indices.
5051

52+
#### Standalone mode
53+
54+
With the `-standalone true` option on the command line or in `application.properties`, you can run the alarm logging service independently of an alarm server.
55+
It may be useful to troubleshoot the system independently from production alarm services using the alarm log service backup for the long alarm log history.
56+
5157
#### Configuration
5258

5359
The alarm logger can be configured via command line switches when running the jar, see option `-help` for details,

0 commit comments

Comments
 (0)