icon/x Created with Sketch.

Splunk Cookie Policy

We use our own and third-party cookies to provide you with a great online experience. We also use these cookies to improve our products and services, support our marketing campaigns, and advertise to you on our website and other websites. Some cookies may continue to collect information after you have left our website. Learn more (including how to update your settings) here.
Accept Cookie Policy

We are working on something new...

A Fresh New Splunkbase
We are designing a New Splunkbase to improve search and discoverability of apps. Check out our new and improved features like Categories and Collections. New Splunkbase is currently in preview mode, as it is under active development. We welcome you to navigate New Splunkbase and give us feedback.

Accept License Agreements

This app is provided by a third party and your right to use the app is in accordance with the license provided by that third-party licensor. Splunk is not responsible for any third-party apps and does not provide any warranty or support. If you have any questions, complaints or claims with respect to this app, please contact the licensor directly.

Thank You

Downloading Annotate
SHA256 checksum (annotate_101.tgz) ed798dbb24ff0643dc9b129d3363cfcad50a97ea19567fb1dfbf8c0d1304ea7d SHA256 checksum (annotate_10.tgz) 5e7bff7d5cb55de9ee12fb6d02cd07fe8b81c3bcc6341986279cbd05946c34b8 SHA256 checksum (annotate_073.tgz) 3206926bfca4c1b9d146f3cbe0a62d8743bf604e2b0c528d11bb30b728ac5b8e SHA256 checksum (annotate_072.tgz) 9f5f20527b6b6182629331845b0fea9a70b88f212e6eeda74e7529595e05227f SHA256 checksum (annotate_071.tgz) 794884777c2df9f2e0f292fd39af4203f10aa50f81bdfb9a6014d6c3a07350fe SHA256 checksum (annotate_07.tgz) 18eabcc7e924f1198b469753d0e99abd298af4e0455d56b96e9bfdef6f2824c1
To install your download
For instructions specific to your download, click the Details tab after closing this window.

Flag As Inappropriate

splunk

Annotate

This app has been archived. Learn more about app archiving.
This app is NOT supported by Splunk. Please read about what that means for you here.
Overview
Details
Annotate utilizes workflow actions to provide an easy way to remember and share events. Annotating an event associates a short note with the event, while flagging an event simply adds a searchable field value to it.

Please read through the documentation to learn how to properly use this app.

Annotating adds a new annotate field to an event and sets a custom value or note as the value. Flagging an event simply sets the annotate field as 'flag'.

---Important---

When performing an annotation, you MUST wait for the search job to finish. Or else, Annotate cannot access the search ID to find the event.

How to annotate events

  1. Perform a Splunk search using any application
  2. In the search string, add:
    | eval annotate="YOUR NOTE"
    • What is typed inside the quotes will be added as the annotation to the event
    • This will render the same search output, but allow us to add a custom field value
  3. Open an event, and find the Event Actions
    • Click "*Annotate: " to annotate a single event
    • Click "*Annotate All: " to annotate all events found in that search job

How to flag events

  1. Perform a Splunk search using any application
  2. Open an event, and find the Event Actions
    • Click "*Flag: " to flag a single event
    • Click "*Flag All: " to flag all events found in that search job

View annotated events

  • All
    • Shows all the events that are annotated or flagged
  • Annotations
    • By default shows all annotated events
    • Allows you to search for annotated events
    • For multi-worded annotations, you can search subsets of the annotation
  • Flags
    • Shows all flagged events
  • Search
    • Just normal Splunk searching

Removing annotations

  1. Navigate to splunk/etc/apps/annotate/lookups
  2. Open the file ticket_correlation.csv (text editor works just fine)
  3. Find the event(s) you want to delete, and remove the row(s)

Customizations

  • You can remove/disable workflow actions from Settings->Fields->Workflow Actions. If you don't think you will ever need an action, just disable it.

  • The dashboards have been left in XML, which means you can still edit them using Splunk's Dashboard Editor. You can add panels and inputs to any of the dashboards.

Release Notes

Version 1.0.1
Aug. 1, 2014

allows subset searching for annotations

Version 1.0
July 31, 2014

first release

Version 0.7.3
July 29, 2014

made dashboard searches faster for annotations
added timecharts to dashboards

Version 0.7.2
July 25, 2014

added time range to dashboards

Version 0.7.1
July 25, 2014

added blank csv file to fix file error

Version 0.7
July 25, 2014

Beta Release: #1


Subscribe Share

Are you a developer?

As a Splunkbase app developer, you will have access to all Splunk development resources and receive a 10GB license to build an app that will help solve use cases for customers all over the world. Splunkbase has 1000+ apps from Splunk, our partners and our community. Find an app for most any data source and user need, or simply create your own with help from our developer portal.

Follow Us:
Splunk, Splunk>,Turn Data Into Doing, Data-to-Everything, and D2E are trademarks or registered trademarks of Splunk Inc. in the United States and other countries. All other brand names,product names,or trademarks belong to their respective owners.