Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/betahuhn/ackee-report
📈 CLI tool to generate performance reports of websites using the self-hosted analytics tool Ackee.
https://github.com/betahuhn/ackee-report
ackee analytics cli email-report privacy website-analytics
Last synced: 3 months ago
JSON representation
📈 CLI tool to generate performance reports of websites using the self-hosted analytics tool Ackee.
- Host: GitHub
- URL: https://github.com/betahuhn/ackee-report
- Owner: BetaHuhn
- License: mit
- Created: 2020-10-25T19:52:50.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2023-01-16T04:07:13.000Z (about 2 years ago)
- Last Synced: 2024-11-10T01:55:19.098Z (3 months ago)
- Topics: ackee, analytics, cli, email-report, privacy, website-analytics
- Language: EJS
- Homepage: https://github.com/electerious/Ackee
- Size: 757 KB
- Stars: 27
- Watchers: 3
- Forks: 3
- Open Issues: 17
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
README
# ackee-report
[](https://github.com/BetaHuhn/ackee-report/blob/master/LICENSE)  [](https://www.npmjs.com/package/ackee-report)
CLI tool to generate performance reports of websites using the self-hosted analytics tool Ackee.
## 👋 Introduction
[ackee-report](https://github.com/BetaHuhn/ackee-report) lets you create monthly website performance reports using your [Ackee](https://github.com/electerious/ackee) analytics data and either send them via email, generate a RSS feed or output it to a JSON file. It uses [Ackee's](https://github.com/electerious/ackee) Graphql API and can be configured to generate multiple reports for different websites, data ranges and recipients.
## 🚀 Get started
Install [ackee-report](https://github.com/BetaHuhn/ackee-report) globally via npm:
```shell
npm install ackee-report -g
```
> ackee-report@latest requires Ackee >=v3.1.1. Use [email protected] for older versions of Ackee
After that `ackee-report` is ready to be used 🎉
## ⚙️ Configuration
On the first run [ackee-report](https://github.com/BetaHuhn/ackee-report) will ask you to input a few values:
- *ackee server* / `ACKEE_SERVER` - the endpoint of your Ackee instance
- *ackee token* / `ACKEE_TOKEN` - a permanent Ackee token (can be used instead of username and password, [more info](#ackee-api-authentication))
- *ackee username* `ACKEE_USERNAME` - your Ackee username ([more info](#ackee-api-authentication))
- *ackee password* `ACKEE_PASSWORD` - your Ackee password ([more info](#ackee-api-authentication))
- *email host* / `EMAIL_HOST` - the domain of the email server ([more info](#email-setup))
- *email port* / `EMAIL_PORT` - the port of the email server ([more info](#email-setup))
- *email username* / `EMAIL_USERNAME` - the username to use with the email server ([more info](#email-setup))
- *email password* / `EMAIL_PASSWORD` - the password to use with the email server ([more info](#email-setup))
- *email from* / `EMAIL_FROM` - the from address to use ([more info](#email-setup))
The configuration will be stored in your home directory under `~/.config/configstore/ackee-report.json` and can be changed at any point.
### Environment Variables
If you don't want to interact with [ackee-report](https://github.com/BetaHuhn/ackee-report) via the CLI interface, you can also specify each configuration option as an environment variable e.g. `ACKEE_TOKEN=`
### Ackee API authentication
[ackee-report](https://github.com/BetaHuhn/ackee-report) needs access to your Ackee instance via the API in order to get all the data it needs to generate the report. You can choose any of the two authentication methods below:
**Username and password:**
Enter your username and password you use to login to the Ackee UI on the first run of [ackee-report](https://github.com/BetaHuhn/ackee-report) or change it in the config file later.
[ackee-report](https://github.com/BetaHuhn/ackee-report) will then use them to create a temporary access token each time it runs and use it to query the Ackee API.
**Permanent access token (recommended):**
The recommended way of authenticating [ackee-report](https://github.com/BetaHuhn/ackee-report) is with a permanent access token (only available with Ackee [v2.2.0](https://github.com/electerious/Ackee/releases/tag/v2.2.0) or later).
You will have to create one via the Ackee UI under `Settings`/`Permanent Tokens`, then click on `New permanent token` and give it a name (doesn't matter what).
Copy the `permanent token id` and enter it on the first run of [ackee-report](https://github.com/BetaHuhn/ackee-report) or add it to the config file under `ackee.token` later.
The same token will then be used each time [ackee-report](https://github.com/BetaHuhn/ackee-report) runs to query the Ackee API.
### Email setup
If you want to send your report via email, you have to specify your email providers SMTP server and credentials, as well as the from option:
- *Host* - `smtp.example.com`
- *Port* - `465`
- *Username* - `[email protected]`
- *Password* - `password`
- *From* - `[email protected]` or `Ackee `
> **Note:** For port 465 ackee-report will use TLS when connecting to your email server, on all other ports it will use STARTTLS (#44)
Common providers:
Gmail
If you use gmail to send emails, use these values:
- *Host* - `smtp.gmail.com`
- *Port* - `465`
- *Username* - your gmail username (your email address)
- *Password* - your gmail password or if you have 2FA enabled, an ["Application Specific password"](https://security.google.com/settings/security/apppasswords)
SendGrid
If you use SendGrid to send emails, use these values:
- *Host* - `smtp.sendgrid.net`
- *Port* - `465`
- *Username* - `apikey` (everyone's username is apiKey)
- *Password* - your API Key (generate one [here](https://app.sendgrid.com/settings/api_keys))
MailGun
If you use SendGrid to send emails, use these values:
- *Host* - `smtp.mailgun.org`
- *Port* - `465`
- *Username* - `[email protected]`
- *Password* - get your password [here](https://app.mailgun.com/app/domains)
## 📚 Usage
```shell
Usage: ackee-report [options]
CLI tool to generate performance reports of websites using the self-hosted analytics tool Ackee.
Commands:
email [options] Generate report and send it via email
json [options] Query API for data and output it to JSON file
html [options] Generate report and output it to a HTML file
rss|xml [options] Generate report as a RSS feed
domains|domain [titles...] get domain id by title
config output current config
help [command] display help for command
Options:
General:
-d, --domain specify domains by title
-i, --id specify domains by id
-r, --range specify data range (default: "month")
-l, --limit limit number of list items (default: 3)
-e, --events [type] get event data (default: false)
-v, --version output the version number
-h, --help display help for command
Email:
-t, --to to whom the report should be sent
RSS/JSON/HTML:
-o, --output path to output file (default: "report.[xml/json/html]")
Example call:
$ ackee-report email --domain example.com --to [email protected]
```
If you want to send the report periodically, you have to setup a cron job which runs the command at a set interval (example below).
## 🛠️ Examples
### Generate a report for one domain and send it via email
```shell
ackee-report email -d example.com -t [email protected]
```
This will generate a report for the domain `example.com` and send it via email to `[email protected]`.
### Multiple domains and recipients
```shell
ackee-report email -d example.com example2.com -t [email protected] [email protected]
```
### Include events in report
```shell
ackee-report email -d all -t [email protected] -e
```
### Average event type
```shell
ackee-report email -d all -t [email protected] -e avg
```
### Custom range
You can specify the data range of the report with the `-r`/`--range` option:
```shell
ackee-report email -d example.com -t [email protected] -r day
```
Available values: `day`/`week`/`month`/`six_months`.
**Note:** The `total views/range` value is calculated by counting the views of the last x days since the program ran. For the `month` range for example, it is not the number of views in the current month, but the number of views in the last 30 days.
### Send the report periodically (cron)
To send a report periodically, for example every month at the 28th at 23:55 setup a cron job like this:
```shell
55 23 28 * * ackee-report email -d example.com -t [email protected] >> /tmp/ackee-report.log 2>&1
```
**Note:** We use the 28th as running on the last day of the month is very complicated with cron and Ackee resets its data on the first day of each month.
**Note:** You may have to specify the actual path to ackee-report. In that case, replace `ackee-report` in the command above with the output of `which ackee-report`.
If you are not familiar with cron, [here's](https://ostechnix.com/a-beginners-guide-to-cron-jobs/) a tutorial on how to get started.
To send multiple reports to different people, add them all as seperate cron jobs.
### Generate RSS feed
You can generate a RSS feed/xml file instead of sending the report via email:
```shell
ackee-report rss -d example.com -o output.xml
```
### Output the report to a JSON file
You can also save the report in a JSON file:
```shell
ackee-report json -d example.com -o output.json
```
### Output the email report to a HTML file
You can also save the report, which is normally sent via email, directly to an HTML file:
```shell
ackee-report html -d example.com -o index.html
```
## 🖼️ Screenshot
## 💻 Development
Issues and PRs are very welcome!
Run `yarn lint` or `npm run lint` to use eslint.
Please check out the [contributing guide](CONTRIBUTING.md) before you start.
To see differences with previous versions refer to the [CHANGELOG](CHANGELOG.md).
## ❔ About
This library is an extension to the awesome privacy focused analytics tool [Ackee](https://github.com/electerious/ackee).
[Ackee](https://github.com/electerious/ackee) was developed by [@electerious](https://github.com/electerious), if you want to support him and the development of Ackee visit [the Donate section](https://github.com/electerious/ackee#donate) on the Ackee repository.
## License
Copyright 2020 Maximilian Schiller
This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.