metrixio/twitter

This tool lets you easily gather data about tweets, retweets, likes, followers, and more from Twitter. You can use it to track the performance of your own account or gather data for research or analysis. It works with Prometheus and Grafana.

1.0.0 2022-12-26 21:15 UTC

Requires

• php: >=8.1
• ext-mbstring: *
• abraham/twitteroauth: ^4.0
• nesbot/carbon: ^2.63
• spiral/framework: ^3.5
• spiral/roadrunner-bridge: ^2.1

Requires (Dev)

• phpunit/phpunit: ^9.5
• spiral/testing: ^2.2
• symfony/var-dumper: ^6.1
• vimeo/psalm: dev-master

MIT

README

This tool lets you easily gather data about tweets, retweets, likes, followers, and more from Twitter. You can use it to track the performance of your own account or gather data for research or analysis.

It works with Prometheus and Grafana to collect data from Twitter, store it in Prometheus, and create visualizations with Grafana. You can use Grafana to customize the data you collect and create dashboards that fit your needs.

We hope you find it helpful!

Usage

To get started with this package, you'll need to have a Twitter developer account and create Twitter API credentials. Once you have those, you can begin collecting metrics data from Twitter.

It's a simple process that can help you track the performance of your own account or gather data for research or analysis purposes.

Check out the documentation in the dashboard repository. That should give you all the details you need to get going.

# Twitter
TWITTER_CONSUMER_KEY=
TWITTER_CONSUMER_SECRET=
TWITTER_ACCESS_TOKEN=
TWITTER_ACCESS_TOKEN_SECRET=

# Twitter account ids to follow (comma separated)
TWITTER_ACCOUNTS=

Docker

version: "3.7"

services:
  twitter-metrics:
    image: ghcr.io/metrixio/twitter:latest
    environment:
      TWITTER_CONSUMER_KEY:...
      TWITTER_CONSUMER_SECRET:...
      TWITTER_ACCESS_TOKEN:...
      TWITTER_ACCESS_TOKEN_SECRET:...
      TWITTER_ACCOUNTS:...
    restart: on-failure

  prometheus:
    image: prom/prometheus
    volumes:
      - ./runtime/prometheus:/prometheus
    restart: always

  grafana:
    image: grafana/grafana
    depends_on:
      - prometheus
    ports:
      - 3000:3000
    volumes:
      - ./runtime/grafana:/var/lib/grafana
    restart: always

Local server

composer create-project metrixio/twitter

Define the repositories you want to track in .env file

# Twitter
TWITTER_CONSUMER_KEY=xxx
TWITTER_CONSUMER_SECRET=xxx
TWITTER_ACCESS_TOKEN=xxx
TWITTER_ACCESS_TOKEN_SECRET=xxx

# Twitter account ids to follow (comma separated)
TWITTER_ACCOUNTS=1234,123123

Once the project is installed and configured you can start application server:

./rr serve

Metrics will be available on http://127.0.0.1:2112.

Note: To fix unable to open metrics page, change metrics address in RoadRunner config file to 127.0.0.1:2112.

The package is built with some of the best tools out there for PHP. It's powered by Spiral Framework, which makes it super fast and efficient, and it uses RoadRunner as the server, which is a really great tool for collecting metrics data for Prometheus.