diff --git a/services/alarm-logger/README.md b/services/alarm-logger/README.md index cd73a9618e..dccd801092 100644 --- a/services/alarm-logger/README.md +++ b/services/alarm-logger/README.md @@ -53,24 +53,38 @@ including those used to create daily, weekly or monthly indices. The alarm logger can be configured via command line switches when running the jar, see option `-help` for details, or via properties documented in [here](https://github.com/ControlSystemStudio/phoebus/blob/master/services/alarm-logger/src/main/resources/alarm_logger.properties) +#### Check Service Status +``` +http://localhost:8080 +``` +Will provide information regarding the version of the service along with information about the connection status with the elastic backend. -### Query the Data - -For more elaborate queries, use Kibana or other elasticsearch clients. -For a first test, this should list one or more `*alarm*` indices: +e.g. ``` -curl -X GET 'http://localhost:9200/_cat/indices?v' +{ + "name": "Alarm logging Service", + "version": "4.7.4-SNAPSHOT", + "elastic": { + "status": "Connected", + "clusterName": "elasticsearch", + "clusterUuid": "hwn6nGDwTKSm8vzVTqR9Sw", + "version": "co.elastic.clients.elasticsearch._types.ElasticsearchVersionInfo@51e5581d" + } +} ``` -This dumps records from one specific index: +### Query the Data + +Alarm logs can be retrieved using the alarm logging services query REST API's ``` -curl -X GET 'http://localhost:9200/accelerator_alarms_state_2019-02-01/_search?format=json&pretty' +curl -X GET 'localhost:8080/search/alarm?pv=*' ``` + ## Data Management The most common aspects for effectively configuring the alarm logger are: @@ -114,4 +128,4 @@ A full list of checks is documented [here](https://maven.apache.org/maven-releas **Perform the release** `mvn -Darguments="-Dskip-executable-jar" -Pdocs,releases release:perform` Checkout the release tag, build, sign and push the build binaries to sonatype. The `docs` profile is needed in order -to create required javadocs jars. \ No newline at end of file +to create required javadocs jars.