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

Publicise the LogViewer plugin #8834

Closed
4 tasks done
mattab opened this issue Sep 22, 2015 · 6 comments
Closed
4 tasks done

Publicise the LogViewer plugin #8834

mattab opened this issue Sep 22, 2015 · 6 comments
Assignees
Labels
c: New plugin For features that probably will not be added to Matomo, but could be implemented as plugins. c: Website matomo.org For issues related to our matomo.org website. Enhancement For new feature suggestions that enhance Matomo's capabilities or add a new report, new API etc.
Milestone

Comments

@mattab
Copy link
Member

mattab commented Sep 22, 2015

in #7239 we created a great little LogViewer plugin, letting any Piwik Super User view the log files created by Piwik.

Goal of this issue is to:

  • release LogViewer on the Marketplace
  • advocate & publicise LogViewer plugin via:

Maybe you have other ideas?

@mattab mattab added the c: Website matomo.org For issues related to our matomo.org website. label Sep 22, 2015
@mattab mattab added this to the 2.15.1 milestone Sep 22, 2015
@tsteur
Copy link
Member

tsteur commented Sep 22, 2015

Plugin is published on the marketplace under http://plugins.piwik.org/LogViewer

@mattab mattab mentioned this issue Sep 22, 2015
27 tasks
@tsteur
Copy link
Member

tsteur commented Oct 26, 2015

What about:

How do I view Piwik application logs?

You can view logs by installing the LogViewer plugin. The plugin can be installed via the Piwik Marketplace with just a few clicks in your Piwik installation. As a Super User simply go to the Administration and select Marketplace in the left menu. There you will find the plugin and can install it with just one click.

This plugin will be useful if you experience any problems with your Piwik installation, for example when some tracking requests are not processed correctly.

IMAGE FROM https://raw.githubusercontent.com/piwik/plugin-LogViewer/master/screenshots/LogViewer.png if possible

Configuring logging in Piwik

By default Piwik won't show anything in the LogViewer plugin as logs are written only to screen. In order to actually view logs you need to enable either logging to file or to the database. The database log writer is recommended when you use more than one server for your Piwik installation.

You can read about this in detail in the FAQ article How do I enable logging in Piwik.

In most cases it is enough to add the following lines to your config/config.ini.php file:

[log]
log_writers[] = file

If you do not see any log messages afterwards this might be just because there were no warnings or errors yet. You can increase the log level by adding the following line to the [log] section to see if it works in general:

log_level = DEBUG

Configuring logging for the Piwik Tracker

The Piwik Tracker API needs an additional configuration in order to actually log something. See the documentation page about enabling Debug logging in the piwik.php tracker

Using the LogViewer plugin

Once logging is configured you can view the logged messages as a Super User by going to the Administration and selecting LogViewer from the Diagnostic section.

You can search for any log messages, filter by log level, switch between the file and database writer and export log messages. Handy is the possibility to narrow down the displayed messages by clicking on a column. For example you can click on a RequestId and see all messages that were logged during the same request.

@tsteur
Copy link
Member

tsteur commented Oct 26, 2015

We can mention it in other parts, such as the logging FAQ and some developer pages once the FAQ article is published

@tsteur tsteur self-assigned this Oct 26, 2015
@tsteur
Copy link
Member

tsteur commented Oct 26, 2015

Assigning to @mattab to publish FAQ article

@mattab
Copy link
Member Author

mattab commented Oct 27, 2015

@tsteur thanks! Faq published at: How do I view Piwik application logs?

mattab pushed a commit to matomo-org/developer-documentation that referenced this issue Oct 27, 2015
@mattab
Copy link
Member Author

mattab commented Oct 27, 2015

Added "Viewing Logs" section in: http://developer.piwik.org/guides/logging#viewing-logs

@mattab mattab closed this as completed Oct 27, 2015
@mattab mattab added Enhancement For new feature suggestions that enhance Matomo's capabilities or add a new report, new API etc. c: New plugin For features that probably will not be added to Matomo, but could be implemented as plugins. labels Jan 29, 2016
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
c: New plugin For features that probably will not be added to Matomo, but could be implemented as plugins. c: Website matomo.org For issues related to our matomo.org website. Enhancement For new feature suggestions that enhance Matomo's capabilities or add a new report, new API etc.
Projects
None yet
Development

No branches or pull requests

2 participants