New

The executive guide to generative AI

Read more
About usPartnersSupport|Login
IMPORTANT: No additional bug fixes or documentation updates will be released for this version. For the latest information, see the current release documentation.
« Best practices Security best practices »
Elastic Docs ›Kibana Guide [7.9] ›Developer guide ›Best practices

Stability

edit
IMPORTANT: This documentation is no longer updated. Refer to Elastic's version policy and the latest documentation.

Stability

edit

Ensure your feature will work under all possible Kibana scenarios.

Environmental configuration scenarios

edit

  • Cloud

  • Multiple Kibana instances

    • Pointing to the same index

    • Pointing to different indexes

      • Should make sure that the Kibana index is not hardcoded anywhere.
      • Should not be storing a bunch of stuff in Kibana memory.
      • Should emulate a high availability deployment.
      • Anticipating different timing related issues due to shared resource access.
      • We need to make sure security is set up in a specific way for non-standard Kibana indices. (create their own custom roles)
  • Kibana running behind a reverse proxy or load balancer, without sticky sessions. (we have had many discuss/SDH tickets around this)
  • If a proxy/loadbalancer is running between ES and Kibana

Kibana.yml settings

edit
  • Using a custom Kibana index alias

  • When optional dependencies are disabled

    • Ensure all your required dependencies are listed in kibana.json dependency list!

Test coverage

edit
  • Does the feature have sufficient unit test coverage? (does it handle storeinSessions?)
  • Does the feature have sufficient Functional UI test coverage?
  • Does the feature have sufficient Rest API coverage test coverage?
  • Does the feature have sufficient Integration test coverage?

Browser coverage

edit

Refer to the list of browsers and OS Kibana supports https://www.elastic.co/support/matrix

Does the feature work efficiently on the list of supported browsers?

Upgrade Scenarios - Migration scenarios-

edit

Does the feature affect old indices, saved objects ? - Has the feature been tested with Kibana aliases - Read/Write privileges of the indices before and after the upgrade?

« Best practices Security best practices »