JSON logger is the default logging module built into Sitefinity CMS. It's possible to integrate Sitefinity's Audit trail module with external logging tools as well.To easily integrate with Elasticsearch and Kibana servers, you will need to first install the ElasticSearchAuditTrailLogger module.
There are 2 options for installing the module:
Elasticsearch is an open-source Java-based web server, used by Sitefinity's Audit trail module for storing and querying logged records, instead of using the textual log files.
During setup, you need to run the Elasticsearch server on the web server machine, on a dedicated machine, on premise, in the cloud, or in a cluster of machines.
Kibana is Elasticsearch's web server that uses static HTML pages and client-side AJAX calls for querying and visualizing records from Elasticsearch in the form of advanced reports and custom dashboard screens.
Set the JAVA_HOME environment variable to point to your Java installation folder.
For more information, see Set the JAVA_HOME System Variable.
In the steps to follow, %ElasticsearchPath% refers to the path where your Elasticsearch files reside.
For example, you do this when a number of developers work in the same room.
RECOMMENDATION: As Sitefinity's Elasticsearch audit logger invokes Elasticsearch RESTful services synchronously, to improve performance, we recommend that you ensure minimum network latency between your web server and your Elasticsearch server. If this is an issue, you can install a dedicated logging agent (for exmaple, Logstash) on the web server machine, to provide out-of-process buffering and persistence of the logged messages.
In the steps to follow, %KibanaPath% refers to the path where your Kibana files reside.
SECURITY NOTE: As Kibana is a client-side HTML application, which invokes the Elasticsearch REST API directly from the client's browser, the Elasticsearch server must be accessible from the machine of every user who is allowed to view the audit log. To avoid unrestricted access to the audit log (either through Kibana or just by calling the REST services of the Elasticsearch server), employ some network protection mechanism like a firewall (for example, white listing user IPs) or a dedicated VPN. In addition, make sure that these restrictions do not prevent Sitefinity CMS from connecting to Elasticsearch.
Back To Top