knightth0r/plugin-visitorgenerator

Plugin to create fake visits, websites, users and goals to populate Piwik reports

Piwik VisitorGenerator Plugin

Description

Plugin to create fake visits, websites, users and goals. This can be used by Piwik users or developers as an easy way to generate fake data to populate Piwik reports.

You can overwrite the log files that are used to generate fake visits in plugins/VisitorGenerator/data or add new logs to the data directory. All files ending with *.log will be replayed.

Plugin developers can provide their own log files by placing '*.log' files within a 'data' directory of their plugin. This way plugin developers make sure there will be always useful test data.

Usage

UI

The plugin adds a new item to the Piwik admin UI visible only for users having Super User access under the section "Development". There you can select a site and for how many days in the past you want to generate new visits.

Note: you need to first enable the Development mode in Piwik. In the root directory of your Piwik install, run the following command to enable development mode: ./console development:enable

CLI

It also adds the following commands to the Piwik CLI tool:

• Generate visits
• Generate goals
• Generate users
• Generate websites
• Generate annotation
• Shorten log file
• Anonymize log file

Examples

• ./console visitorgenerator:generate-annotation --idsite 5 generate one annotation for the current day for site with id 5
• ./console visitorgenerator:generate-goals --idsite 5 generates some predefined goals for site with id 5
• ./console visitorgenerator:generate-users --limit 100 generates 100 users
• ./console visitorgenerator:generate-websites --limit 100 generates 100 websites
• ./console visitorgenerator:generate-visits --idsite 5 generates many visits for site with id 5 for today
• ./console visitorgenerator:generate-visits --idsite 5 --days 2 generates many visits for site with id 5 for today and yesterday
• ./console visitorgenerator:anonymize-log /path/to/log takes an Apache log file, anonymizes it and places it in a data directory so it will be replayed the next time "generate-visits" is executed
• ./console visitorgenerator:shorten-log /path/to/file.log > file.short.log takes a large Apache log file and keeps only a small number of logs per day
• ./console visitorgenerator:generate-visits --idsite 5 --custom-piwik-url=http://example.com/ Uses 'http://example.com/' as Piwik-URL and generates many visits for site with id 5 for today

Legalnotice

This plugin is released under the GPLv3+ license.

This plugin uses the Faker library which is released under the MIT license.