New in version 1.14.0
The Splunk Add-on Builder is a Splunk app that helps you build and validate technology add-ons for your Splunk Enterprise deployment. The goals of the Splunk Add-on Builder are to:. Guide you through all of the necessary steps of creating an add-on. Build alert actions and adaptive response actions for Splunk Enterprise Security. We would like to show you a description here but the site won’t allow us.
100% Free Logo Maker. Professional and Unique Designs. Make your Design & Download it for Free. Design a Logo Online with the #1 Logo Creator. Create your custom Form Builder for any website. No coding required. Get started free. Trophy icon description. Trusted on over 12,000,000 websites.
The Aggregation Pipeline Builder in MongoDB Compass provides the ability tocreate aggregation pipelines toprocess data. With aggregation pipelines, documents in a collectionor view pass through multiple stages where they are processed into aset of aggregated results. The particular stages and results can bemodified depending on your application's needs.
To access the aggregation pipeline builder, navigate to thecollection or view for which you wish to create anaggregation pipeline and click the Aggregations tab. Youare presented with a blank aggregation pipeline. ThePreview of Documents in the Collection section of theAggregations view displays 20 documents sampled from thecurrent collection.
To populate the Aggregation Pipeline Builder, you can either:
- Create a new Aggregation Pipeline in the UI,
- Open a saved pipeline, or
Create an Aggregation Pipeline¶
Add an aggregation pipeline stage.¶
In the aggregation pipeline pane in the bottom-left of the view,click the Select... dropdown and select theaggregation pipeline stage to use for the firststage of the pipeline:
Fill in the pipeline stage.¶
Fill in your selected stage. As you modify the pipeline stage, thepreview documents shown in the pane to the right of the stageupdate automatically to reflect the results of your pipeline as itprogresses, provided Auto Preview is enabled:
Add additional pipeline stages.¶
Add additional aggregation stages as desired by clicking theAdd Stage button below your last aggregation stage.Repeat steps 1 and 2 for each additional stage.
The toggle to the right of the name of each pipeline stagedictates whether that stage is included in the pipeline. Togglinga pipeline stage also updates the pipeline preview, which reflectswhether or not that stage is included.
The following pipeline excludes the first$match stageand only includes the$projectstage:
Specify Custom Collation¶
Use custom collation to specifylanguage-specific rules for string comparison, such as rules forletter case and accent marks.
To specify a custom collation:
- Click the Collation button at the top of the pipelinebuilder.
- Enter your collation document.
Limitations¶
The $out
stage is not available if you are connected to aData Lake.
Save a Pipeline¶
You can save a pipeline so that you can access it later. If youload a saved pipeline, you can modify it withoutchanging the original saved copy. You can also create a view from your pipeline results.
To save your pipeline:
- Click the Save button at the top of the pipelinebuilder.
- Enter a name for your pipeline.
- Click Save.
Create a View from Pipeline Results¶
Creating a view from pipeline results does not save the pipelineitself.
To create a view from your pipeline results:
- Click the arrow next to the Save button at the topof the pipeline builder.
- Click Create a View.
- Enter a name for your view.
- Click Create.
Elementor Page Builder Icon
Compass creates a view from your pipeline results in the samedatabase where the pipeline was created.
Open a Saved Pipeline¶
- Click the Folder icon at the top left of thepipeline builder.
- Hover over the pipeline you want to open and click Open.
- In the modal, click Open Pipeline.
Pipeline Options¶
The toggles at the top of the pipeline builder control thefollowing options:
Option | Description |
---|---|
| (Recommended) When enabled, limits input documents passed to$group , $bucket , and$bucketAuto stages. Set the document limit with theLimit setting. |
| When enabled, Compass automatically updates thepreview documents pane to reflect the results of each activestage as the pipeline progresses. |
Pipeline Settings¶
To view and modify pipeline settings:
- Click the gear icon at the top right of the pipeline builder toopen the Settings panel.
Modify the pipeline settings. The following settings can be modified:
Option Description Default Comment Mode
¶
When enabled, adds helper comments to each stage. Enabled Number of Preview Documents
¶
Number of documents to show in the preview. 20 Max Time
¶
Cumulative time limit in milliseconds for processingthe pipeline. Use this option to prevent long hang times. 5000 Limit
¶
When Sample Mode is enabled, number of documentspassed to $group
,$bucket
, and$bucketAuto
stages. Lower limits improve pipelineexecution time, but may miss documents.100000 - Click Apply to save changes and close theSettings panel.
Example¶
The following example walks through creating and executing a pipelinefor a collection containing airline data. You can download thisdataset from the following link:air_airlines.json.
For instructions on importing JSON data into your cluster, seemongoimport. Thisprocedure assumes you have the data in theexample.air_airlines
namespace.
Create the Pipeline¶
The following pipeline has two aggregation stages:$group
and $match
.
- The
$group
stage groups documents by theiractive
status andcountry
. The stage also addsa new field calledflightCount
containing the numberof documents in each group. - The
$match
stage filters documents to only returnthose with aflightCount
value greater than orequal to5
.
Copy the Pipeline to the Clipboard¶
Click the Export to Language button at the topof the pipeline builder. The button opens the following modal:
- Click the Copy button in the My Pipelinepanel on the left. This button copies your pipeline to yourclipboard in
mongo
shell syntax. You will use thepipeline in the following section.
Lutheran Service Builder Icon Picture
Home Builder Icon
Execute the Pipeline¶
- Launch and connect to amongod instance which contains the imported
air_airlines.json
dataset. Switch to the
example
database where theair_airlines
collection exists:Run the following command to execute the pipeline created inCompass:
Building Icon Word
The following is an excerpt of the documents returned bythe pipeline: