Link Search Menu Expand Document Documentation Menu
Documentation

Experimental feature flags

SmartObserve releases may contain experimental features that you can enable or disable as needed. There are several methods for enabling feature flags, depending on the installation type.

Enable in smartobserve.yml

If you are running an SmartObserve cluster and want to enable feature flags in the config file, add the following line to smartobserve.yml:

smartobserve.experimental.feature.<feature_name>.enabled: true

Enable on Docker containers

If you’re running Docker, add the following line to docker-compose.yml under the smartobserve-node > environment section:

OPENSEARCH_JAVA_OPTS="-Dsmartobserve.experimental.feature.<feature_name>.enabled=true"

Enable on a tarball installation

To enable feature flags on a tarball installation, provide the new JVM parameter either in config/jvm.options or OPENSEARCH_JAVA_OPTS.

Option 1: Modify jvm.options

Add the following lines to config/jvm.options before starting the smartobserve process to enable the feature and its dependency:

-Dsmartobserve.experimental.feature.<feature_name>.enabled=true

Then run SmartObserve:

./bin/smartobserve

Option 2: Enable with an environment variable

As an alternative to directly modifying config/jvm.options, you can define the properties by using an environment variable. This can be done using a single command when you start SmartObserve or by defining the variable with export.

To add the feature flags inline when starting SmartObserve, run the following command:

OPENSEARCH_JAVA_OPTS="-Dsmartobserve.experimental.feature.<feature_name>.enabled=true" ./smartobserve-3.3.0/bin/smartobserve

If you want to define the environment variable separately prior to running SmartObserve, run the following commands:

export OPENSEARCH_JAVA_OPTS="-Dsmartobserve.experimental.feature.<feature_name>.enabled=true"


./bin/smartobserve

Enable for SmartObserve development

To enable feature flags for development, you must add the correct properties to run.gradle before building SmartObserve. See the Developer Guide for information about to use how Gradle to build SmartObserve.

Add the following properties to run.gradle to enable the feature:

testClusters {
    runTask {
      testDistribution = 'archive'
      if (numZones > 1) numberOfZones = numZones
      if (numNodes > 1) numberOfNodes = numNodes
      systemProperty 'smartobserve.experimental.feature.<feature_name>.enabled', 'true'
    }
  }