Python Shell HTML Vim script PHP
Latest commit 9bc95fc Nov 22, 2016 @bd808 sal: Use safesubst: for template invocations
On a SAL page like the production one invoking [[Template:SAL entry]]
hundreds of times on each page edit is very costly. We can use the subst
trick instead to pretty up each entry at the time it is added without
the linear growth in page parse time. Thanks to Brad Jorsch for pointing
this fix out.

README.md

Stashbot

An IRC bot designed to store data in an Elasticsearch cluster.

This bot was created to replace Logstash in an application stack that processes IRC messages for:

  • quips
  • SAL
  • (an as yet unwritten IRC history search system)

In addition to its original Elasticsearch storage purpose, the bot has expanded to support:

  • Updating Phabricator tasks mentioned in !log irc massages
  • Providing summary information for Phabricator manifest, differential, and pholio objects mentioned in irc messages
  • Writing !log messages to a MediaWiki wiki
  • Posting !log messages to Twitter

Install

$ virtualenv virtenv
$ source virtenv/bin/activate
$ pip install -r requirements.txt

Configure

The bot is configured using a yaml file. By default stashbot.py will look for a configuration file named config.yaml. An alternate file can be provided using the --config cli argument. See stashbot.py --help for more information.

Example configuration:

---
irc:
  server: chat.freenode.net
  port: 6667
  nick: mybotnick
  realname: My Real Name
  channels:
    - '##somechan'
    - '##anotherchan'
  ignore:
    - nick1
    - nick2

elasticsearch:
  servers:
    - tools-elastic-01.tools.eqiad.wmflabs
    - tools-elastic-02.tools.eqiad.wmflabs
    - tools-elastic-03.tools.eqiad.wmflabs
  options:
    port: 80
    http_auth:
      - my-es-username
      - my-es-password
    sniff_on_start: false
    sniff_on_connection_fail: false
  index: 'irc-%Y.%m'

ldap:
  uri: ldap://ldap-labs.eqiad.wikimedia.org:389
  base: dc=wikimedia,dc=org

phab:
  url: https://phabricator.wikimedia.org
  user: MyPhabUser
  key: api-xxxxxxxxxxxxxxxxxxxxxxx
  echo: "%(fullName)s - %(uri)s"
  notin:
    - '##somechan'
  delay:
    __default__: 300
    '##somechan': 600

mediawiki:
  wikitech:
    url: https://wikitech.wikimedia.org
    consumer_token: aaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaa
    consumer_secret: bbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbbb
    access_token: cccccccccccccccccccccccccccccccc
    access_secret: dddddddddddddddddddddddddddddddddddddddd
  otherwiki:
    url: https://wiki.example.com
    consumer_token: 11111111111111111111111111111111
    consumer_secret: 2222222222222222222222222222222222222222
    access_token: 33333333333333333333333333333333
    access_secret: 4444444444444444444444444444444444444444

twitter:
  wikimediatech:
    consumer_key: aaaa
    consumer_secret: bbbb
    access_token_key: cccc
    access_token_secret: dddd

bash:
  view_url: https://tools.wmflabs.org/bash/quip/%s

sal:
  view_url: https://tools.wmflabs.org/sal/log/%s
  phab: "{nav icon=file, name=Mentioned in SAL, href=%(href)s} [%(@timestamp)s] <%(nick)s> %(message)s"
  channels:
    '##somechan':
      project: someproject
      wiki: wikitech
      page: Foo/SAL
      category: SAL
      acl:
        default: deny
        allow:
            - *!*@*.example.net
            - *!*@wikimedia/*
    '##anotherchan':
      project: anotherproject
      wiki: otherwiki
      page: Another project logs
      leader: ===
      acl:
        deny:
            - *!*jerk@*.domain
    '##otherchan':
      use_config: '##somechan'

Operating the bot

# Start the bot
$ ./bin/stashbot.sh start

# Stop the bot
$ ./bin/stashbot.sh stop

# Tail logs
$ ./bin/stashbot.sh tail

License

GNU GPLv3+

Some code and much inspiration taken from: