Kibana: Difference between revisions

From Freephile Wiki
m formatting
m move references
 
(4 intermediate revisions by 2 users not shown)
Line 1: Line 1:


To use Kibana with MediaWiki CirrusSearch, you need to configure your MediaWiki installation to send search data to an Elasticsearch cluster (which is what CirrusSearch uses), and then access that data through Kibana by setting up a connection to the Elasticsearch instance, allowing you to visualize and analyze your MediaWiki search queries and results within Kibana's interface.  
To use Kibana with [[MediaWiki]] CirrusSearch, you need to configure your MediaWiki installation to send search data to an Elasticsearch cluster (which is what CirrusSearch uses), and then access that data through Kibana by setting up a connection to the Elasticsearch instance, allowing you to visualize and analyze your MediaWiki search queries and results within Kibana's interface.  


== Key steps involved ==
== Key steps involved ==
Line 12: Line 12:
* '''Configure Kibana access:'''
* '''Configure Kibana access:'''
** Access your Kibana interface by navigating to the Kibana URL (usually on the same server as Elasticsearch).
** Access your Kibana interface by navigating to the Kibana URL (usually on the same server as Elasticsearch).
** The default port is 5601
** In Kibana settings, add a connection to your Elasticsearch cluster.
** In Kibana settings, add a connection to your Elasticsearch cluster.
* '''Index data in Elasticsearch:'''
* '''Index data in Elasticsearch:'''
Line 23: Line 24:


== Or just use Meza==
== Or just use Meza==
Our [https://github.com/freephile/meza Meza] now has Kibana!  
Our [https://github.com/freephile/meza Meza] now has Kibana!<ref>
# {{done}} [https://github.com/freephile/meza/issues/37 Install Kibana as a dashboard]
## {{done}} [https://github.com/freephile/meza/issues/58 Add a new role for Kibana]
## {{done}} [https://github.com/freephile/meza/issues/59 configure Kibana]
## {{done}} [https://github.com/freephile/meza/issues/60 secure Kibana]</ref>


==Important Considerations==
==Important Considerations==
Line 35: Line 40:
===Performance optimization===
===Performance optimization===
Monitor the performance of your Elasticsearch cluster to handle the volume of search data generated by MediaWiki.
Monitor the performance of your Elasticsearch cluster to handle the volume of search data generated by MediaWiki.
== Alternatives ==
[https://docs.opensearch.org/docs/latest/dashboards/ Dashboards] is the [[OpenSearch]] equivalent to Kibana.
Wikimedia Foundation uses [https://grafana.wikimedia.org/dashboards Grafana] for dashboards like [https://grafana.wikimedia.org/goto/HvrM3GENR?orgId=1 monitoring elasticsearch]
{{References}}
[[Category:Search]]
[[Category:Elasticsearch]]
[[Category:MediaWiki]]
[[Category:QualityBox]]

Latest revision as of 14:03, 20 August 2025

To use Kibana with MediaWiki CirrusSearch, you need to configure your MediaWiki installation to send search data to an Elasticsearch cluster (which is what CirrusSearch uses), and then access that data through Kibana by setting up a connection to the Elasticsearch instance, allowing you to visualize and analyze your MediaWiki search queries and results within Kibana's interface.

Key steps involved[edit]

  • Install CirrusSearch extension on MediaWiki:
    • Download and install the CirrusSearch extension on your MediaWiki instance.
    • Configure the extension to point to your Elasticsearch cluster details (host, port, index name) in your MediaWiki LocalSettings.php file.
  • Set up Elasticsearch cluster:
    • Install and configure an Elasticsearch cluster on your server.
    • Ensure compatibility between your MediaWiki version and the Elasticsearch version you choose.
  • Configure Kibana access:
    • Access your Kibana interface by navigating to the Kibana URL (usually on the same server as Elasticsearch).
    • The default port is 5601
    • In Kibana settings, add a connection to your Elasticsearch cluster.
  • Index data in Elasticsearch:
    • Once CirrusSearch is active on your MediaWiki, your search queries will automatically be indexed in Elasticsearch.
  • Create visualizations in Kibana:
    • Use Kibana's data exploration tools to create dashboards and visualizations based on your MediaWiki search data, including:
      • Top search queries
      • Search query trends over time
      • Distribution of search results across different categories
      • Analysis of search terms used by specific user groups

Or just use Meza[edit]

Our Meza now has Kibana![1]

Important Considerations[edit]

Data mapping[edit]

Ensure that the data indexed by CirrusSearch is properly mapped to Elasticsearch fields for optimal analysis in Kibana.

Security[edit]

Implement appropriate security measures on your Elasticsearch cluster to restrict access to sensitive data.

Performance optimization[edit]

Monitor the performance of your Elasticsearch cluster to handle the volume of search data generated by MediaWiki.

Alternatives[edit]

Dashboards is the OpenSearch equivalent to Kibana.

Wikimedia Foundation uses Grafana for dashboards like monitoring elasticsearch

References[edit]