Skip to content

PunchPlatform Plugin Overview

Kibana Punchplatform Plugin Home Page

The plugin is a set of features developed by Punchplatform. Its goal is to search for additional Kibana features that are accessible and powerful.

Here is a breakdown of the features of the kibana Punchplatform plugin:

  1. Platform Resources: Data travels from a point to another through a channel. Configure channels punchlets;
  2. Data extractions: Easily execute data extraction. Use it to create subsets of data to display in Kibana or export as csv.
  3. Punch Machine Learning: Use all the power of Spark and Machine Learning with the Punch Machine Learning (PML) graphical editor;
  4. Resource Manager: Easily test and run punchlets or grok patterns.
  5. Documentation: Need help? Check the Punchplatform documentation without leaving kibana;

Tenant Editor

This files explorer allows you to view the complete configuration of your channels and punchlets. Browse the tree on the left, click on a file name and view its contents.

Kibana Punchplatform Plugin Channel Configuration

You can only view files. Changes will not take effect.

Data extraction

Data extractions retrieves subsets of data. Using filters, you can filter data to be extracted and choose where to extract them.

Create an extraction

To create a new extraction, click on Extraction Editor in the top menu.

Before you perform an extraction

  • make sure you have added an index pattern in Kibana.
  • Save a kibana search from Discover tab.

Fill in the fields

Kibana Punchplatform Plugin Data Extractions Editor

Kibana Punchplatform Plugin Data Extractions Editor

  • Kibana saved search: Select from which save search (made from Discover) to extract the data
  • Extraction range: Select date range
  • Max size: Set maximum output rows
  • Extract _id: Check to add a column id which contains Elasticsearch document _id
  • Extract all fields: Check to add a column source which contains Elasticsearch document _source
  • Fields to extract: Select fields you want in your subset. Click on the field to put it into the other column. The available fields are on the left, the selected fields are on the right.
    TIPS: Use arrows between columns to move all from left to right and vice-versa.
  • Filters: Add filters on your extract data
  • Description: Name your extraction
  • Output format: Choose where to extract, in another Elasticsearch index, or in file (CSV/JSON)
  • Tenant: Choose in which tenant perform extraction

You can then Save form and go to Executions to launch your extraction.

Display extractions

Click on Extractions in the top menu. All extractions created are displayed on this screen.

Kibana Punchplatform Plugin Data Extractions Scheduler

You can see extraction information like id, description, current status, output location and perform actions.

  • Status: Available status are Scheduled, Submitted, Running, Success, Failed.
  • Output: Extracted data location, if is in Elasticsearch, extracted data are in an new index pattern, add it in Kibana (settings), else if output is a file (CSV or JSON), you can download file directly.

Resource manager

Kibana Punchplatform Plugin Create References Sets

The resource manager is a remote storage space allowing you to store your various Punch resources, such as machine learning models, parsers or recording files. You can then access these resources using the REST API in your Punchline nodes.

Add a resource

Kibana Punchplatform Plugin Add Resource

You can create a new resource by clicking on Create resource in the contextual menu of a category, or from the New resource button. You can also upload one or multiple local files by clicking on the Upload resource option.

Update a resource

Kibana Punchplatform Plugin Update Resource

By clicking on the three dots icon next to a resource name, you can easily duplicate the resource, move it in another category, copy its URL, change its type, download or delete it.

To add or edit the description of a resource, click on the edit icon next to the description as shown below. Enter the desired description and click OK ; the new content is shown in the description panel. To save the description, click on the Save button at the far right of the page.

Kibana Punchplatform Plugin Edit_Description

Edit .punch resources

Kibana Punchplatform Plugin Edit_Description

If your resource is a punchlet, you can test it by entering test data in the right input area and click on the green arrow button at the top right of the punchlet editor. The results will be displayed below the input area. Punchlet editors are slightly different depending on the kind of punchlet you're editing ; for example, if you're working on a Nifi punchlet as shown in the screenshot above, the input area lets you enter Nifi attributes in a table for better readability.


To change the type of a resource, click on the three dots next to the resource name in the tree view > Change resource type > select the type you want.

The code editor understand the Punch language ; you can autocomplete method names or use snippets of code.

Manage versions of a resource

You can edit the content of a resource with the code editor and save your modifications by clicking on the Save button. This will create a new version of the file, and you can switch versions using the Version dropdown at the left of the Save button.

Punch Tools

You can learn the Punch language or improve your skills using the Punch Tools, which are samples of punchlets, patterns or Spark SQL testers you can play with.

To access to the Punch Tools, you need to add the samples to the Resource Manager. To do so, run the following script in the Punchplatform install directory :

Then navigate to the Resource Manager in Kibana and you will see new folders : - patterns: Grok and Dissect patterns - punchlets: basic and advanced examples of punchlets - spark_sql: CSV and JSON examples of using Spark SQL

Kibana Punchplatform Plugin Punch Tour

Punchline Editor

Punchplatform offers an intuitive graphical interface to use the Spark's strength. Use drag and drop to place nodes in a graph, connect and configure nodes, click on Execute. That's all.

Create a Punchline graph

Drag a node on the left menu and drop it on the grid.

Put many nodes on the graph and connect. The links are automatically configured.

Kibana Punchplatform Plugin Spark Graph

Double-click on the node to edit it, all field are automatically updated at the change. You can read help for configuring nodes in chapter Machine-Learning in this documentation.

Kibana Punchplatform Plugin Spark Editor View

When your graph is ready, you can display full configuration by clicking on view button in the toolbar. Save or Save & execute graph. You can see execution detail in the Spark Scheduler tab.

Display Punchline executions

You can see execution detail in the Spark Scheduler tab.

Kibana Punchplatform Plugin Spark Scheduler

  • Status: Available status are Scheduled, Submitted, Running, Success, Failed.


Need help? Check the Punchplatform documentation without leaving kibana;

Kibana Punchplatform Plugin Documentation