Seyren (/ˈsaɪ.rʌn/) is an alerting dashboard for Graphite. It supports the following notification channels:
###Prerequisites
- An instance of Graphite
- MongoDB ([Install instructions](http://docs.mongodb.org/manual/installation/#installation-guides Installing MongoDB))
###Run
wget https://github.com/scobal/seyren/releases/download/1.1.0/seyren-1.1.0.jar
export GRAPHITE_URL=http://graphite.foohost.com:80
java -jar seyren-1.1.0.jar
open http://localhost:8080
To run seyren on another port:
export SEYREN_URL="http://localhost:8081/seyren"
java -jar seyren-1.1.0.jar -httpPort=8081
###Config
The following options can be supplied as system properties or environment variables.
MONGO_URL- The Mongo connection string. Default:mongodb://localhost:27017/seyrenSEYREN_URL- The location of your Seyren instance. Default:http://localhost:8080/seyrenSEYREN_LOG_PATH- The path of seyren.log. Default: ``. If a value is set, it must end with a '/'.
GRAPHITE_URL- The location of your Graphite server. Default:http://localhost:80GRAPHITE_REFRESH- The fixed period (in ms) between checks. Default:60000GRAPHITE_USERNAME- The HTTP Basic auth username for the Graphite server. Default: ``GRAPHITE_PASSWORD- The HTTP Basic auth password for the Graphite server. Default: ``GRAPHITE_KEYSTORE- The HTTP KeyStore path for the https Graphite server. Default: 93FC ``GRAPHITE_KEYSTORE_PASSWORD- The HTTP KeyStore password for the HTTPS Graphite server. Default: ``GRAPHITE_TRUSTSTORE- The HTTP TrustStore path for the https Graphite server. Default: ``GRAPHITE_CONNECTION_REQUEST_TIMEOUT- The number of millisconds to wait to obtain a connection from the pool. Default:0(infinite)GRAPHITE_CONNECT_TIMEOUT- The number of milliseconds to wait to establish a connection. Default:0(infinite)GRAPHITE_SOCKET_TIMEOUT- The number of milliseconds to wait for request data. Default:0(infinite)
SMTP_HOST- The smtp server to send email notifications from. Default:localhostSMTP_PORT- The smtp server port. Default:25SMTP_FROM- The from email address for sending out notifications. Default:alert@seyrenSMTP_USERNAME- The smtp server username if authenticated SMTP is used. Default: ``SMTP_PASSWORD- The smtp server password if authenticated SMTP is used. Default: ``SMTP_PROTOCOL- The smtp server protocol if authenticated SMTP is used. Default:smtp
FLOWDOCK_EXTERNAL_USERNAME- The username that messages will be sent from to a flow. Default:SeyrenFLOWDOCK_TAGS- Special tags to add to all messages. Default: ``FLOWDOCK_EMOJIS- Mapping between state and emojis unicode. Default: ``
HIPCHAT_AUTHTOKEN- The hipchat api auth token. Default: ``HIPCHAT_USERNAME- The username that messages will be sent from. Default:Seyren Alert
HUBOT_URL- The location where Hubot is running. Default ``
IRCCAT_HOST- The hostname of the server where IRCcat is running. Default:localhostIRCCAT_PORT- The port on which IRCcat is running. Default:12345
PAGERDUTY_DOMAIN- The PagerDuty domain to be notified. Default: ``PAGERDUTY_USERNAME- The PagerDuty API username. Default: ``PAGERDUTY_PASSWORD- The PagerDuty API Password. Default: ``
PUSHOVER_APP_API_TOKEN- Your pushover App API Token
GRAPHITE_CARBON_PICKLE_ENABLE- Enable a TCP server to listen Carbon relay pickle protocol. Default:falseGRAPHITE_CARBON_PICKLE_PORT- The TCP server port. Default:2004
SLACK_TOKEN- The Slack api auth token. Default: ``SLACK_USERNAME- The username that messages will be sent to slack. Default:SeyrenSLACK_ICON_URL- The user icon URL. Default: ``SLACK_EMOJIS- Mapping between state and emojis unicode. Default: ``
SNMP_HOST- The SNMP host. Default:localhostSNMP_PORT- The SNMP port. Default:162SNMP_COMMUNITY- The SNMP community. Default:publicSNMP_OID- The SNMP OID. Default:1.3.6.1.4.1.32473.1
TWILIO_ACCOUNT_SID- The Twilio Account SID. Default ``TWILIO_AUTH_TOKEN- The Twilio Auth Token. Default ``TWILIO_PHONE_NUMBER- The Twilio phone number to use to send SMS. Default ``TWILIO_URL- The Twilio API URL. Mostly useful for testing. Defaulthttps://api.twilio.com/2010-04-01/Accounts
##Chef
You can use Seyren Cookbook to deploy Seyren with Chef.
##Development
To run the acceptance tests with Maven:
mvn clean verify
To run the integration tests with Maven:
mvn clean verify -Pkarma
To fire-up the app using Maven and wait (meaning you can run the tests separately from your IDE):
mvn clean verify -Dwait
You should then be able to browse to http://localhost:8080/seyren and have a play.
To package up a new jar file without running the tests:
mvn package -DskipTests
# Set environment variables as needed.
java -jar seyren-web/target/seyren-web-*-war-exec.jar

