coveo/uabot repository overview
uabot 
Bot to send "intelligent" random usage analytics to simulate visits, queries and clicks on a site. Works with a configuration file using json format. Check the /scenarios_examples folder for examples.
How to use:
- Download executable.
- Set Environment variables (refer to the section below).
- Build your scenarios (How to build scenarios).
- Execute the bot.
Tracing
You can use the argument -trace to get more logs when debugging your scenarios.
Usage documentation
Code documentation
Supports
- Search events
- Click events
- Custom events
- Facet events
- View events
- TabChange events
Environment variables
Needs 3 environment variables to function :
| Variable | Usage |
|---|---|
| SEARCHTOKEN | API key to search |
| UATOKEN | API key to send events to UA |
| SCENARIOSURL | Url to the scenario JSON file to randomize |
| LOCAL | true for local (default false) |
On windows
set SEARCHTOKEN=value
set UATOKEN=value
set SCENARIOSURL=value
set LOCAL=true #if scenariosurl is a local path
On MAC
export SEARCHTOKEN = value
export UATOKEN = value
export SCENARIOSURL = value
export LOCAL=true #if scenariosurl is a local path
Developper section
To build an executable
# Install the dependencies
1. go get
# Build an executable -o sets the output name
2. go build -o myexecutable
3. Run the executable
To trigger a Docker rebuild, push with latest tag
1. Commit your changes
# We need to use the -f option here because tag latest already exists
2. git tag -f -a latest -m "Rebuild reason here"
# Push changes to branch + push changes to tag, you will need to supply credentials twice.
3. git push && git push -f --tags
To release a newer version of the bot, with Travis automated builds
# Create a new tag with the version number to use.
1. git tag -a [v0.9.9] -m "Release comment here"
# Push tag.
2. git push --tags origin master
# It takes a little bit of time for Travis to generate the artefacts
3. Visit https://github.com/coveo/uabot/releases to view the releases to ensure your new release is visible.
Tag summary
Content type
Image
Digest
Size
334.3 MB
Last updated
almost 6 years ago
docker pull coveo/uabot