Data Platform/Systems/EventLogging/TestingOnBetaCluster
 | This documentation is outdated. See Event_Platform/Instrumentation_How_To. |
The consumer side of event logging can be easily tested on Beta Cluster.
Instance
The instance name is configured here: https://github.com/wikimedia/operations-mediawiki-config/blob/master/wmf-config/CommonSettings-labs.php Note that this might change at any time but other than the instance the rest of the info on this document should apply regardless of the instance
Note that you need sudo on this instance to see logs, any user trying to test stuff on Beta Cluster should ask for sudo on deployment-eventlog08.
It is unfortunate that sudo is required but that is the state of affairs right now.
How to create test events
How to log a client-side event to Beta Cluster directly
Just hit the varnish endpoint on labs for example:
curl -A "WikipediaApp/22.0.22-alpha-2017-11-01 (Android 8.0.0; Phone) Alpha Channel" https://en.wikipedia.beta.wmflabs.org/beacon/event?{"event":{"pageTitleSource":"Main Page","namespaceIdSource":0,"pageIdSource":1,"isAnon":true,"popupEnabled":true,"pageToken":"3ec574813fadb97b","sessionToken":"8460c2e4d547b250","previewCountBucket":"0 previews","hovercardsSuppressedByGadget":false,"action":"pageLoaded"},"revision":16364296,"schema":"Popups","webHost":"en.wikipedia.beta.wmflabs.org","wiki":"enwiki"}
https://en.wikipedia.beta.wmflabs.org/beacon/event?{"event":{"country":"US","region":"WA","anonymous":true,"project":"wikipedia","db":"enwiki","uselang":"en","device":"desktop","debug":false,"randomcampaign":0.8838892205730462,"randombanner":0.7340400211496478,"recordImpressionSampleRate":0.01,"impressionEventSampleRate":1,"status":"banner_shown","statusCode":"6","campaign":"CN browser tests","campaignCategory":"CNbrowsertests","campaignCategoryUsesLegacy":false,"bucket":0,"banner":"browser_test_b3","bannerCategory":"CNbrowsertests","result":"show","testIdentifiers":"popupsUnknown"},"revision":17995347,"schema":"CentralNoticeImpression","webHost":"en.wikipedia.beta.wmflabs.org","wiki":"enwiki"};
How to log via the website
Use http://en.m.wikipedia.beta.wmflabs.org/wiki/Main_Page to create events in mobile, for example.
How to load test with a bunch of events
There's a script that may be handy. It's in the same eventlogging codebase:
https://github.com/wikimedia/eventlogging/blob/master/bin/eventlogging-load-tester
How to verify events
You can tail the files in the /srv/log/eventlogging on deployment-eventlog08.deployment-prep.eqiad1.wikimedia.cloud to verify if your event is coming through.
Unless noted otherwise, the files mentioned in this section and the subsections are in this directory.
ssh deployment-eventlog08.deployment-prep.eqiad1.wikimedia.cloud cd /srv/log/eventlogging
Validated events
In MySQL
All events in beta should be written to the MySQL log database hosted on the beta eventlogging server.
ssh deployment-eventlog08.deployment-prep.eqiad1.wikimedia.cloud sudo mysql --skip-ssl log show tables; ...
In files
all-events.log: schema-validated events that are inserted into MYSQL appear in this file (the all* in name is missleading).
Tail this file while you use the website and emit server or client side events. If your events are valid your events should be there after a short while (seconds). The contents of this file are of the eventlogging_valid_mixed topic in Kafka.
In Kafka
You can consume valid events directly from kafka:
kafkacat -L -b deployment-kafka-jumbo-1.deployment-prep.eqiad1.wikimedia.cloud:9092 | grep 'topic "eventlogging_' | awk -F '"' '{print $2}'
will list topics .
After, consume from your topic. It should be named something like eventlogging_<schema>. You should be able to see your events if they are valid.
kafkacat -C -b deployment-kafka-jumbo-1.deployment-prep.eqiad1.wikimedia.cloud:9092 -t eventlogging_NavigationTiming
Raw stream of events (including unvalidated events)
client-side-events.log: client side events appear in this file (valid and not)
If events do not appear they might not be valid, check /srv/log/eventlogging/systemd and tail -f grep the following:
[email protected]
Validation errors will appear on those logs and they are very descriptive. Note: you may see a -00 log and a -01 log, which exist for parallelization and you should monitor both.
Where is eventlogging code?
/srv/deployment/eventlogging/analytics/eventlogging
See all EventLogging schema Kafka topics
kafkacat -L -b deployment-kafka-jumbo-1.deployment-prep.eqiad1.wikimedia.cloud:9092 | grep 'topic "eventlogging_' | awk -F '"' '{print $2}'
All event logging topics for which valid events are being sent should be present here
Database
In order to see events you can use the eventlogging user whose user and password are listed at:
/etc/eventlogging.d/consumers/mysql-m4-master
If you have sudo on the machine the mysql password for the root user is 'secret', otherwise:
mysql -h 127.0.0.1 --user=eventlogging --password=68QrOq220717816UycU1 --skip-ssl (it's labs, the password is not really a secret.)
If mysql needs a re-start:
systemctl restart mysql
The mysql setup on beta leaves much to be desired, if mysql does start check /var/log/mysql.err
This might be of help: [1]
Please also keep in mind that the eventlogging_cleaner.py script runs periodically to purge/sanitize records according to its whitelist as it happens in production. Some useful commands:
elukey@deployment-eventlog08:~$ systemctl list-timers | grep sanitization
Wed 2018-10-24 11:00:00 UTC 20h left Tue 2018-10-23 11:00:14 UTC 3h 19min ago eventlogging_db_sanitization.timer eventlogging_db_sanitization.service
elukey@deployment-eventlog08:~$ systemctl cat eventlogging_db_sanitization.service
# /lib/systemd/system/eventlogging_db_sanitization.service
[Unit]
Description=Apply Analytics data retetion policies to the Eventlogging database
[Service]
User=eventlogcleaner
ExecStart=/usr/local/bin/eventlogging_cleaner ...[cut]...
Two notable things:
- --no-whitelist-sanity-check is not used in production but only in beta.
- The systemd timer updates /srv/eventlogging/eventlogging_cleaner with the timestamp of the next day to start sanitizing from during the next run (that happens once a day).
Admin
Give people access
Add them to the lists on these wikis (you need to be an admin to do that) Asking in #wikimedia-cloud connect might be a way to get help.
Special:NovaProject -> add users to deployment-prep
How to deploy code
# Log into the beta deploy server
ssh deployment-tin.deployment-prep.eqiad1.wikimedia.cloud
# cd to the EventLogging analytics deploy source
cd /srv/deployment/eventlogging/analytics
# Deploy using scap3 in the beta environment
scap deploy -e beta
You can run puppet with
puppet agent -tv
Restart EventLogging
Check:
sudo eventloggingctl status
Run:
sudo eventloggingctl restart
Stop completely:
sudo eventloggingctl stop