Skip to content

Use Kibana

Kibana Gateway exposes your Hydrolix tables through Kibana as Elasticsearch indices, so you can explore them in Discover and build dashboards. A cluster administrator enables the integration on the cluster; see Set up Kibana. For general Kibana guidance, see the Kibana documentation.

Access Kibana⚓︎

After the integration is running, Kibana is served at the /kibana path on your Hydrolix cluster hostname. Replace hostname.hydrolix.live with your cluster hostname.

  1. Sign in to the Hydrolix cluster UI at https://hostname.hydrolix.live.
  2. Go to https://hostname.hydrolix.live/kibana.

For sign-in details, see Authentication.

Authentication⚓︎

How you sign in to Kibana depends on the kibana_security_enabled tunable in the HydrolixCluster spec, which defaults to false.

Cluster authentication (default)⚓︎

With kibana_security_enabled: false, Kibana's own login is turned off. The cluster's shared authentication protects the /kibana path, so the credentials that gate the rest of the Hydrolix UI also gate Kibana. Signing in to the cluster UI is enough, and Kibana doesn't prompt for a separate login.

Elasticsearch authentication⚓︎

Set kibana_security_enabled to true to turn on Kibana's own login page, which validates credentials against Elasticsearch.

Enable Kibana security
1
2
spec:
  kibana_security_enabled: true

Shared account warning

When enabling this feature, all Kibana access uses same credentials, so data access isn't isolated by user or tenant.

The hdx-elastic-user account is a single, shared account, effectively, a data superuser account with access to all tables in the cluster.

Sign in with the credentials in the hdx-elastic-user Kubernetes secret:

  • Username: hydrolix by default. Set a different username with kibana_gateway_config.elasticsearch_username.
  • Password: generated for each cluster and can't be changed.

Retrieve the password with:

Retrieve the Kibana password
1
kubectl get secret hdx-elastic-user -o jsonpath='{.data.password}' | base64 -d

Create a data view⚓︎

The in-cluster Kibana integration uses the hydro.logs table as a data source by default. After you access Kibana, create a data view for a Hydrolix table:

  1. Select Stack Management from the main menu.
  2. Select Kibana > Data Views.
  3. Create a data view:
    • If this is your first data source, select the link in the text "You can also create a data view against hidden, system, or default indices" at the bottom of the introduction page.
    • If this isn't your first data source, select the Create data view button.
  4. Enter a name, index pattern, and timestamp in the form.
  5. Select Save data view to Kibana.

Summary tables are detected and exposed as indexes too. A summary table holds pre-aggregated data, so its fields differ from the raw table it summarizes. Create a data view for it and query it the same way, in Discover or in dashboards. You can't filter on a summary table's aggregate columns; filter on its dimension columns instead.