Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/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.
https://github.com/metrixio/twitter
collector docker grafana metrics php81 prometheus prometheus-metrics roadrunner spiral-framework
Last synced: 27 days ago
JSON representation
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.
- Host: GitHub
- URL: https://github.com/metrixio/twitter
- Owner: metrixio
- License: mit
- Created: 2022-12-23T14:38:43.000Z (almost 2 years ago)
- Default Branch: master
- Last Pushed: 2022-12-27T10:32:52.000Z (almost 2 years ago)
- Last Synced: 2024-09-29T20:03:57.356Z (about 1 month ago)
- Topics: collector, docker, grafana, metrics, php81, prometheus, prometheus-metrics, roadrunner, spiral-framework
- Language: PHP
- Homepage: https://dashboard.metrixio.dev/
- Size: 1.49 MB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Twitter metrics collector
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](https://developer.twitter.com/en/docs/basics/authentication/guides/access-tokens.html). 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](https://github.com/metrixio/dashboard) repository. That should give you all the details you need to get going.
```dotenv
# Twitter
TWITTER_CONSUMER_KEY=
TWITTER_CONSUMER_SECRET=
TWITTER_ACCESS_TOKEN=
TWITTER_ACCESS_TOKEN_SECRET=
# Twitter account ids to follow (comma separated)
TWITTER_ACCOUNTS=
```
### Docker
```yaml
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
```bash
composer create-project metrixio/twitter
```
Define the repositories you want to track in `.env` file
```dotenv
# 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:
```bash
./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](https://github.com/spiral/framework/), which makes it super fast and efficient, and it uses [RoadRunner](https://github.com/roadrunner-server/roadrunner) as the server, which is a really great tool for collecting metrics data for Prometheus.