jenkins-bot has submitted this change and it was merged.

Change subject: Document AuthManagerStatsdHandler better
......................................................................


Document AuthManagerStatsdHandler better

Change-Id: I499fa5ce8db5619f4c706512224f60928e341306
---
M includes/AuthManagerStatsdHandler.php
1 file changed, 14 insertions(+), 1 deletion(-)

Approvals:
  Anomie: Looks good to me, approved
  jenkins-bot: Verified



diff --git a/includes/AuthManagerStatsdHandler.php 
b/includes/AuthManagerStatsdHandler.php
index 02e1955..5d5f21d 100644
--- a/includes/AuthManagerStatsdHandler.php
+++ b/includes/AuthManagerStatsdHandler.php
@@ -26,9 +26,22 @@
 use Monolog\Handler\AbstractHandler;
 
 /**
- * Counts authentication-related log calls (those sent to the 'authmanager'
+ * Counts authentication-related log events (those sent to the 'authevents'
  * channel) via StatsD.
  *
+ * Events can include the following data in their context:
+ *   - 'event': (string, required) the type of the event (e.g. 'login').
+ *   - 'type': (string) a subtype for more complex events.
+ *   - 'successful': (bool) whether the attempt was successful. Can be omitted 
if 'status' is
+ *     a Status or a StatusValue.
+ *   - 'status': (Status|StatusValue|string|int) attempt status (such as an 
error message key).
+ *     string/int values will be ignored unless 'successful' is false.
+ *
+ * Will result in a ping to a graphite key that looks like
+ * <MediaWiki 
root>.authmanager.<event>.<type>.<entrypoint>.[success|failure].<status>
+ * Some segments will be omitted when the appropriate data is not present.
+ * <entrypoint> is 'web' or 'centrallogin' or 'api' and filled automatically.
+ *
  * Used to alert on sudden, unexplained changes in e.g. the number of login
  * errors.
  */

-- 
To view, visit https://gerrit.wikimedia.org/r/311067
To unsubscribe, visit https://gerrit.wikimedia.org/r/settings

Gerrit-MessageType: merged
Gerrit-Change-Id: I499fa5ce8db5619f4c706512224f60928e341306
Gerrit-PatchSet: 1
Gerrit-Project: mediawiki/extensions/WikimediaEvents
Gerrit-Branch: master
Gerrit-Owner: Gergő Tisza <gti...@wikimedia.org>
Gerrit-Reviewer: Anomie <bjor...@wikimedia.org>
Gerrit-Reviewer: Chad <ch...@wikimedia.org>
Gerrit-Reviewer: Ori.livneh <o...@wikimedia.org>
Gerrit-Reviewer: jenkins-bot <>

_______________________________________________
MediaWiki-commits mailing list
MediaWiki-commits@lists.wikimedia.org
https://lists.wikimedia.org/mailman/listinfo/mediawiki-commits

Reply via email to