samw
/
twitter-prometheus
1
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

Add readme

This commit is contained in:
Sam W 2020-08-02 16:22:42 +01:00
parent 5f83fc7bce
commit d07c6f16fb
1 changed files with 12 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
readme.md Normal file
View File

@ -0,0 +1,12 @@
# Intro
A very simple prometheus exporter for getting the follower count of twitter accounts, for the intersection of "people who care about their twitter follower count" and "people who run their own monitoring infrastructure".
# Usage
`twitter-prometheus`. That's it. If you want, you can specify a listenaddr with `-listen`. It defaults to `:9700`.
# Metrics
- `/metrics` - the usual built in metrics for go programs
- `/probe?screen_name=foo` - the follower count for twitter user with screen name foo
# How it do
Uses the `https://cdn.syndication.twimg.com/widgets/followbutton/info.json` *unauthenticated* JSON API. Twitter may well turn this off or rate limit aggressively.