Configuration of ZeppNotebookTest

Apache Zeppelin is an open web-based notebook that enables interactive data analytics and collaborative documents with SQL, Scala, Python, R and more. It brings data ingestion, data exploration, visualization, sharing and collaboration features to Hadoop and Spark. Apache Zeppelin interpreter concept allows any language/data-processing-backend to be plugged into Zeppelin. Zeppelin currently supports many interpreters such as Apache Spark, Python, JDBC, Markdown and Shell. Also, Apache Zeppelin provides built-in Apache Spark integration.

A Zeppelin notebook is a browser-based GUI for interactive data exploration, modeling, and visualization. As a notebook author or collaborator, you write code in a browser window. When you run the code from the browser, Zeppelin sends the code to backend processors such as Spark. The processor or service returns results; you can then use Zeppelin to review and visualize results in the browser. Apache Zeppelin has a pluggable notebook storage mechanism controlled by zeppelin.notebook.storage configuration option with multiple implementations.

Notes are fundamental elements of a Zeppelin notebook and each instance of Zeppelin has only one notebook which contains many notes. The user can create, import or delete notes which will be stored by default in the Zeppelin home notebook folder. Zeppelin is considered to be a Big Data tool which support multi-user capability. Thus, it is difficult to keep track on the number of notebooks created or deleted from Zeppelin. For this eG enterprise offers ZeppNotebookTest. This test reports the number of notebooks currently stored in the Zeppelin notebook folder and detailed diagnosis of this measure provides the name and ID of all the notebooks present in Zeppelin. This metric helps administrators to figure out the details of notebooks that are currently present in Zeppelin.

The default parameters associated with this test are:

• The TEST PERIOD list box helps the user to decide how often this test needs to be executed.

• In the HOST text box, specify the HOST for which this test is to be configured.

• In the PORT text box, specify the port at which the target Zeppelin server listens to. The default port is 8080.

• To collect metrics from an Apache zeppelin server, the eG agent monitoring the server should be configured to use JMX to connect to the JVM used by the server and pull out the metrics of interest. If JMX requires authentication only (but no security), then ensure that the USER NAME and PASSWORD parameters are configured with the credentials of a user with read-write access to JMX. To know how to create this user, refer to Monitoring Apache Zeppelin. Confirm the password by retyping it in the CONFIRM PASSWORD text box.

• By default, the SSL flag is set to No indicating that the SSL (Secured Socket Layer) is not used to connect to the target Apache Zeppelin. If not so, set the SSL flag to Yes.

• Specify the duration (in seconds) for which this test should wait for a response from the Apache Zeppelin server in the TIMEOUT text box. If there is no response from the server beyond the configured duration, the test will timeout. By default, this is set to 5 seconds.

• To make diagnosis more efficient and accurate, eG embeds an optional detailed diagnostic capability. With this capability, the eG agents can be configured to run detailed, more elaborate tests as and when specific problems are detected. To enable the detailed diagnosis capability of this test, by default, for a particular server, choose the On option against DETAILED DIAGNOSIS. To disable the capability, click on the Off option.

  The option to selectively enable/disable the detailed diagnosis capability will be available only if the following conditions are fulfilled:

  • The eG manager license should allow the detailed diagnosis capability.

  • Both the bad and normal frequencies configured for the detailed diagnosis measures should not be 0.

• If multiple components of the same component type are awaiting configuration, then an APPLY TO OTHER COMPONENTS button will appear in this page. Clicking on this button will allow you to apply the configuration to all/selected components of that type.

• Once the necessary values have been provided, clicking on the UPDATE button will register the changes made.

When changing the configuration for specific servers, a “*” beside the text box corresponding to the parameter signifies that these values have to be manually configured by the user. The parameter values that require to be configured will typically be prefixed with a “$” or contain a series of “*”. A value of “none” in the parameter value indicates that the corresponding parameter value can be changed if required.