Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

How do I monitor that Piwik service is up? #7904

Closed
mattab opened this issue May 14, 2015 · 8 comments
Closed

How do I monitor that Piwik service is up? #7904

mattab opened this issue May 14, 2015 · 8 comments
Labels
Task Indicates an issue is neither a feature nor a bug and it's purely a "technical" change.
Milestone

Comments

@mattab
Copy link
Member

mattab commented May 14, 2015

Let's create a new FAQ to document how to monitor that a Piwik server is running smoothly.

What do you think?

How do I monitor that Piwik service is up?

To monitor for Piwik service, setup the following checks:

  • Tracker API: request to /piwik.php should return http status 200
  • Core platform: request to /index.php?module=API&method=API.XXX should return http status 200

We recommend to use https:// in the checks URLs so you're also checking Piwik works over secured connection.

Likely the tool you use for monitoring will let you know the services Uptime (eg. 99%) which is useful metric.

@mattab mattab added the Task Indicates an issue is neither a feature nor a bug and it's purely a "technical" change. label May 14, 2015
@mattab
Copy link
Member Author

mattab commented May 14, 2015

Notes

@mattab
Copy link
Member Author

mattab commented Jul 15, 2015

@mattab mattab closed this as completed Jul 15, 2015
@mattab mattab added this to the 2.14.1 milestone Jul 15, 2015
@gaumondp
Copy link

I read @mattab FAQ and was wondering if the check involved the database at all. If "MySQL has gone away" the test to index.php?module=API&method=API.getPiwikVersion would still work right ?

If it's the case (no DB call) I will create a new FC for a second test involving the DB.

I'm aware a check could be done directly to MySQL with monitoring tools but having the check from within Piwik would be more simple to setup I think.

@mattab
Copy link
Member Author

mattab commented Jul 15, 2015

the index.php check will detect when Mysql server is down and http status should be 500

however the piwik.php check will still work when mysql is down, I looked whether we could provide a piwik.php check that detects the db is down, but it's not easy, so decided not to do it

@gaumondp
Copy link

Ok then.

BTW, the FAQ seems incomplete. We need the &token_auth= . If not, we still get a 200-OK but also an error message saying we don't get view rights in the XML response :

<result> <error message="Vous ne pouvez accéder à cette ressource, ceci requiert au moins un accès de type view à un site web."/> </result>

@mattab
Copy link
Member Author

mattab commented Jul 16, 2015

Thanks @gaumondp FAQ has been updated with token_auth

@mritzmann
Copy link

Does the check also check whether the archiving job is running successfully?

@mattab
Copy link
Member Author

mattab commented Dec 12, 2017

No it doesn't

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Task Indicates an issue is neither a feature nor a bug and it's purely a "technical" change.
Projects
None yet
Development

No branches or pull requests

3 participants