Zeppelin Notebook Test

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 Zeppelin Notebook test. 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.

Target of the test : Apache Zeppelin

Agent deploying the test : An internal/remote agent

Outputs of the test : One set of results for the target Apache Zeppelin.

Configurable parameters for the test
Parameter Description

Test period

How often should the test be executed.


The IP address of the target server that is being monitored.


The port number through which the Apache Zeppelin communicates. The default port is 8080.

Username, Password and Confirm Password

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 target Apache Zeppelin is not SSL-enabled by default. To enable the test to connect to an SSL-enabled Apache Zeppelin, 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.

Detailed Diagnosis

To make diagnosis more efficient and accurate, the eG Enterprise 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 for a particular server, choose the On option. 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 normal and abnormal frequencies configured for the detailed diagnosis measures should not be 0.
Measurements made by the test
Measurement Description Measurement Unit Interpretation

Number of notebooks

Indicates the number of notebooks currently present in Apache Zeppelin.


The detailed diagnosis of this measure lists the names and IDs of the notebooks present in Zeppelin.