Skip to content
GitLab
Projects
Groups
Snippets
Help
Loading...
Help
Help
Support
Community forum
Keyboard shortcuts
?
Submit feedback
Sign in
Toggle navigation
L
lvalert
Project overview
Project overview
Details
Activity
Releases
Repository
Repository
Files
Commits
Branches
Tags
Contributors
Graph
Compare
Locked Files
Issues
0
Issues
0
List
Boards
Labels
Service Desk
Milestones
Iterations
Merge Requests
0
Merge Requests
0
Requirements
Requirements
List
CI / CD
CI / CD
Pipelines
Jobs
Schedules
Test Cases
Security & Compliance
Security & Compliance
Dependency List
License Compliance
Operations
Operations
Incidents
Environments
Packages & Registries
Packages & Registries
Package Registry
Container Registry
Analytics
Analytics
CI / CD
Code Review
Insights
Issue
Repository
Value Stream
Wiki
Wiki
Snippets
Snippets
Members
Members
Collapse sidebar
Close sidebar
Activity
Graph
Create a new issue
Jobs
Commits
Issue Boards
Open sidebar
Thomas Shaffer
lvalert
Commits
0fc787f4
Commit
0fc787f4
authored
Mar 31, 2019
by
Alexander Pace
Browse files
Options
Browse Files
Download
Email Patches
Plain Diff
docs changes
parent
502d1154
Changes
2
Hide whitespace changes
Inline
Side-by-side
Showing
2 changed files
with
64 additions
and
6 deletions
+64
-6
docs/guide.rst
docs/guide.rst
+47
-0
docs/index.rst
docs/index.rst
+17
-6
No files found.
docs/guide.rst
0 → 100644
View file @
0fc787f4
LVAlert Users Guide
===================
The LIGO-Virgo Alert System (LVAlert) is a notification
service built on the XMPP_ protocol and the pubsub extension.
It provides a basic notification tool which allows multiple producers
and consumers of notifications.
The current and legacy (to be depreciated) LVAlert clients are powered by
SleekXMPP_ and PyXMPP_, respectively. The server backend is powered by
Openfire_ v4.2.3.
First Steps
-----------
To use the service, you must first visit the `Account Activation`_ webpage
to set your LVAlert password. Your username is based on your "albert.einstein"
LIGO.org credentials. To obtain a user or robot account with a unique username,
please contact `Alexander Pace`_ or `Tanner Prestegard`_.
LVAlert How To
--------------
LVAlert uses the Publish-Subscribe (PubSub) model to create and distribute
alerts to users. An entity (most commonly, GraceDB_) publishes an alert
to a node (think of it like a channel). Other entities subscribe to that node
(channel) and then listen for content published on the channel.
Alerts from GraceDB take the form of JSON_-formatted strings, whose contents
depend on the action from GraceDB (e.g.: new event upload, new label applied,
etc.). A description of LVAlert message contents from GraceDB is available for events_
and superevents_.
The listener can be configured to take an action upon receipt of an alert.
.. _XMPP: https://xmpp.org/
.. _SleekXMPP: http://sleekxmpp.com
.. _PyXMPP: http://pyxmpp.jajcus.net/
.. _Openfire: https://www.igniterealtime.org/projects/openfire/
.. _Account Activation: https://www.lsc-group.phys.uwm.edu/cgi-bin/jabber-acct.cgi
.. _Alexander Pace: mailto:alexander.pace@ligo.org
.. _Tanner Prestegard: mailto:tanner.prestegard@ligo.org
.. _GraceDB: https://gracedb.ligo.org/
.. _JSON: https://www.json.org/
.. _events: https://gracedb.ligo.org/documentation/lvalert.html#event-alerts
.. _superevents: https://gracedb.ligo.org/documentation/lvalert.html#superevent-alerts
docs/index.rst
View file @
0fc787f4
...
...
@@ -8,13 +8,30 @@ The CLI and API are compatible with Python 3. For backwards compatibility,
legacy Python clients powered by PyXMPP_ are included in the package, but are
slated to be removed from a future release of ligo-lvalert.
User Guide
----------
Please visit the `LVAlert User Guide`_ for a brief overview and starter for the LVAlert
client and service.
Quick Start
-----------
Install from the lscsoft yum repository::
yum install ligo-lvalert
Install from the lscsoft debian repository::
apt install ligo-lvalert
Install with pip_::
pip install ligo-lvalert
Note that the pip installation requires the installation of libxml2, m2crypto, and
swig to support the legacy clients.
Put your username and password in your netrc_ file in ``~/.netrc``::
echo 'machine lvalert-test.cgca.uwm.edu login albert.einstein password gravity' >> ~/.netrc
...
...
@@ -28,12 +45,6 @@ Listen for LVAlert messages::
lvalert listen
User Guide
----------
Please visit the `LVAlert User Guide`_ for a brief overview and starter for the LVAlert
client and service.
API
---
...
...
Write
Preview
Markdown
is supported
0%
Try again
or
attach a new file
.
Attach a file
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Cancel
Please
register
or
sign in
to comment