Skip to content
Punch Documentation
Test Reports
Type to start searching
Official website
Home
Tutorial
Solutions
Reference Guide
Development Guide
Operation Guides
Contribution Guide
Log Management
Product
Punch Documentation
Home
Home
Welcome
Overview
Overview
Architecture
Security
Modularity
Rationale
PunchPlatform versus ELK
Punch components
Key Concepts
Key Concepts
Punchlines
Applications
Plans
Channels
Books
Tenants
Platform
Glossary
Features
Features
Enablers
Feature List
Tutorial
Tutorial
Tutorials
Standalone Getting Started
Standalone Getting Started
Before You Start
You are Impatient !
Setup
Punchlets
Punchlines
Spark Punchlines
Plans
Channels
Monitoring
Elasticsearch and Kibana
Kafka
Clickhouse
Archiving and Extracting
Security
Using Templates
What's Next ?
Parser Getting Started
Deployer Getting Started
Deployer Getting Started
Before you start
Deploy the platform
COTS
Punch Operator
Shiva
Trainings
Trainings
Training Modules
Introduction - HLI
Introduction - HLI
Overview
A Punch Business and Functional Perspective
Punch Components and concepts
Conclusion
Applications - CPA
Applications - CPA
Overview
Punchlines
Applications
Channels
Architecture - ARCH
Architecture - ARCH
Overview
Punch Components
Punch Design Patterns and Reference Architecture
Design Issues Highlights
Administration - ADM
Administration - ADM
Overview
Health/Status tools
Frequent Operation Tasks
Troubleshooting basics
Deployment - DPP
Deployment - DPP
Overview
Deployment process
Platform runtime configuration
Patching and Ansible inventory usage
Upgrade procedure
Monitoring - MON
Monitoring - MON
Overview
Monitoring the Punch platform components
Monitoring the channels and applications
Investigating the channel problems
Elastic - IKQ
Elastic - IKQ
Overview
Indexing Fundamentals
Kibana Discover, with queries and filters
Kibana Visualizations, with aggregations
Kibana Dashboards
General best practices
Punch Kibana plugin
Punch Language - PUN
Punch Language - PUN
Overview
Punch Language Fundamentals
Punchlets
Operators
Resources
Error Handling
Data Streams
Going production
Data Processing - AIM
Data Processing - AIM
Overview
Spark/Pyspark Punchlines fundamentals
Pyspark node development
Spark node development
Extending Spark SQL UDF and UDAF in java
Extending Spark SQL UDF in python
Spark/Pyspark punchlines and channels
Spark/Pyspark punchlines monitoring
Advance use cases
Solutions
Solutions
Archiving
Aggregations
Monitoring
Geospatial
Data Simulation
Reference Guide
Reference Guide
Overview
Configuration
Configuration
Overview
Channels
Books
Punchlines
Plans
Command Line Tools
Command Line Tools
ChannelCtl
PlanCtl
PlatformCtl
KafkaCtl
BookCtl
Punchlines
Punchlines
Storm-like punchlines
Storm-like punchlines
Configuration
Nodes
Nodes
Input
Input
Extraction Input
File
Generator
HTTP
Kafka
Lumberjack
Azure Blob Storage
NSG Azure Blob Storage
Syslog
SNMP
SFTP
SMTP
Processing
Processing
Archive Reader
Punch
Filter Node
Rythmer Node
Output
Output
Elasticsearch
File
File Transfer
Kafka
Lumberjack
MapD
Clickhouse
PostgreSQL
Syslog Tcp
Syslog Udp
Zabbix
Javadocs
Spark/pyspark punchlines
Spark/pyspark punchlines
Configuration
Concepts
Concepts
Spark Primer
Spark Punchlines
User Defined Functions
Spark and Pyspark Dependency Management
Spark Network
Nodes
Nodes
Input
Input
Elastic Input
Python Elastic Input
Elastic Query Stats
File Input
Python File Input
Kafka Stream Input
Kafka Batch Input
File Model Input
Dataset Generator
API Rest Input
Output
Output
Python Elastic Output
Elastic Output
File Output
Kafka Batch Output
Kafka Stream Output
File Model Output
Show
Processing
Processing
Archive Reader
Mllib Model
SQL
Punch
Random Split
Punchlets
Data Collection
Data Collection
Beats
Internal Monitoring
Storage
Storage
Archiving Service
Archiving
Extracting
Extraction Reliability
CephFs Distributed FileSystem
Object storage operation tips
Visualisation
Visualisation
Kibana Plugins
Kibana Plugins
Punch documentation plugin
Data extraction plugin
Data feedback plugin
Kibana Dashboards
Kibana Dashboards
Punch Generic Dashboards
Punch Platform health monitoring dashboards
Punch application metrics monitoring dashboards
Troubleshooting
Troubleshooting
Kibana Troubleshooting
Vega
Vega
Kibana Advanced Vega
Security
Security
Overview
Administration
Audit and Traceability
Data Protection
Alerting
Alerting
Overview
Punch Modules
Application Scheduling
Application Scheduling
Shiva Application Scheduler
Shiva Protocol
REST Gateway
REST Gateway
Gateway
Request Filtering for forwarding
API Reference
Resource Manager
Manual Pages
Manual Pages
environment
channelctl
resourcectl
punchlinectl
platformctl
planctl
sparkctl
punchplatform-development.sh
punchplatform-kafka-topics.sh
punchplatform-kafka-consumers.sh
punchplatform-log-injector.sh
punchplatform-puncher.sh
punchplatform-standalone.sh
punchplatform-push-es-templates.sh
punchplatform-setup-kibana.sh
punchplatform-version.sh
punchplatform-zookeeper-console.sh
punchplatform-inspect-node.sh
Nifi Punch Processor
Development Guide
Development Guide
Overview
Custom Nodes
Custom Nodes
Java Storm Custom Node
Java Spark Custom Node
Python Spark Custom Node
Custom Shiva Applications
Custom Shiva Applications
Java Custom Application
Python Custom Application
Elastalert Custom Modules
User Defined Functions
Punch Programming
Punch Programming
Punchlang
Tuples
Operators
Grok Pattern Matching
Dissect Pattern Matching
Punchlet As a Function
Punchlets inside Punchlines
Exception Handling
Tutorial Write a Log Parser
Tutorial Write a Production Grade Parser
Operation Guides
Operation Guides
Overview
Management
Management
Components Administration Commands
Applicative Administration Commands
Developer and Testing Commands
Reference Architecture
Reference Architecture
Reference Architecture overview
Log Collector
Log Collector
Log Collector (LTR)
Platform Events Forwarder Punchline
Log Central
Log Central
Log Central (LMC)
Central Receiver Punchlines
Central Processor Punchlines
Central Indexer Punchlines
Central Archiver Punchlines
Platform Events Dispatcher Punchlines
Punch Packages
Punch Packages
Shiva
Operator
Gateway
Spark
Storm
Deployment
Deployment
Deployment Process
Deployment Prerequisites
Deployment Prerequisites
Requirements for deployment and target servers
Debian based setup
CentOS based setup
Darwin setup
Deployment Configuration
Deployment Configuration
punchplatform-deployment.settings
Runtime resolver configuration (resolv.yaml)
Punch Framework Deployer Guide
Post-deployment Configuration
Post-deployment Configuration
Post-deployment additional platform Configuration
Tenant Configuration
Patch Procedure
Monitoring
Monitoring
Monitoring Guide
Platform Monitoring
Channels Monitoring
Metrics
Metrics
Metrics Overview
Metrics/Events Reporters
Platform Metrics
Metrics in Apache Storm
Metrics/logs in Apache Spark
Logging
Alerting
Alerting
Elastalert
Housekeeping
Housekeeping
Elasticsearch Housekeeping
Archives Housekeeping
Migration
Migration
Migration Guides
Migration Guides
Breaking changes in 6.0
6.0 to 6.1 Upgrade Notes
6.1 to 6.2 Upgrade Notes
6.2 to 6.3 Upgrade Notes
6.3 to 6.4 Upgrade Notes
Migration Elasticsearch to Opensearch
Security
Security
Configuring Opendistro Security binding with LDAP and associated Elastic/Kibana Role-Based Access Control mappings
Open Distro Security For Elasticsearch
SSL/TLS and other Punchplatform security secrets deployment
Punchplatform TLS certificates
Modsecurity For Elasticsearch
Troubleshooting
Troubleshooting
Deployment issues
Deployment issues
TROUBLESHOOTING Inventories generation
TROUBLESHOOTING Interface name
TROUBLESHOOTING clean older user's public key
TROUBLESHOOTING ansible MODULE FAILURE
TROUBLESHOOTING failed to set permissions on the temporary files ansible
TROUBLESHOOTING kibana deployment issues
TROUBLESHOOTING Unsupported locale setting
TROUBLESHOOTING Wrong shell with admin
TROUBLESHOOTING check initial running status of supervisor Failed
TROUBLESHOOTING No package matching openjdk 8 jdk Ubuntu18.04
TROUBLESHOOTING Git settings in centos
Visualisation issues
Visualisation issues
TROUBLESHOOTING Timelion
TROUBLESHOOTING kibana define default index pattern error
Administration issues
Administration issues
Troubleshooting Channel in PARTIAL state
Troubleshooting kafka topics
Troubleshooting network bandwidth
Troubleshooting using Storm worker logs
Troubleshooting topology already exist on cluster
Troubleshooting Kafka cluster and brokers health
Troubleshooting missing mandatory properties
Troubleshooting channelctl errors
Troubleshooting unable to start a channel
Troubleshooting Spark Cluster
Data Engineer issues
Data Engineer issues
Troubleshooting handling compressed logs
Troubleshooting a punchlet
Troubleshooting Punchlet slow processing
Troubleshooting Dangling Meta Character
Data Analytics
Data Analytics
TROUBLESHOOTING cast errors pml model
TROUBLESHOOTING structured streaming
Production issues
Production issues
Troubleshooting a Channel that is not processing documents
Troubleshooting Slow LTR-LMR connection
Troubleshooting memory/JVM usage
Troubleshooting Automatic ceph service reloading
Troubleshooting under-replication in an Elasticsearch cluster
Troubleshooting no logs in Kibana
Troubleshooting whole elasticsearch cluster unavailability
TROUBLESHOOTING Elasticsearch non nominal status in Nagios
Troubleshooting elasticsearch indexes unavailability
Troubleshooting Ceph insertion slow-down
Troubleshooting Ceph insertion fails
Troubleshooting Kafka errors in production
Troubleshooting Archiving topology logs
Troubleshooting Error on kibana plugin
Common issues
Common issues
TROUBLESHOOTING invalid lumberjack version
TROUBLESHOOTING empty metrics indices
TROUBLESHOOTING could not find nimbus from seed hosts
TROUBLESHOOTING Cope with Out Of Memory java crashes
Standalone issues
Standalone issues
TROUBLESHOOTING kibana standalone
TROUBLESHOOTING Unsupported major minor version
TROUBLESHOOTING STANDALONE
Security issues
Security issues
TROUBLESHOOTING Opendistro Security
How To
How To
Data Movement
Data Movement
HOWTO configure functional tags
HOWTO extract logs from elasticsearch with logger
HOWTO cope with inactive sockets
HOWTO add an enrichment into production
HOWTO filter out logs
HOWTO Handle several technos in one topology
HOWTO replay logs from kafka from a specific date
HOWTO connect lumberjack output of logstash and lumberjack spout of storm
HOWTO archive then extract data
HOWTO replay logs from files to elasticsearch
HOW TO allocate more memory to topologies
HOWTO tune garbage collection
HOWTO flush kafka backlog
HOWTO Connect an EXTERNAL Logstash collector to Punchplatform
HOWTO extract logs from Elasticsearch and write them in files
HOWTO run a small change between two elasticsearch
HOWTO deal with light topology
Data Processing
Data Processing
HOWTO emit multiple events from a punchlet
HOWTO develop punchlets in sublime text
HOWTO test a parser before going to production
Data Analytics
Data Analytics
HOWTO add your analytics algorithm
HOWTO activate logging
Storage
Storage
HOW TO Alter an existing Kafka topic (partitions, retention, replicas)
HOWTO get a specific doc in elasticsearch
HOWTO configure a topology to write logs in ceph archive
HOWTO configure kafka retention
HOWTO hold an apt package
HOWTO change ceph osd nodes in production
HOWTO close indices or create aliases with elastic curator
How to add and configure a new tenant dedicated pool in a Ceph cluster
HOWTO elasticsearch caching highlights
HOWTO elasticsearch REST API Tips and tricks
Visualisation
Visualisation
HOWTO configure kibana plugin
Security
Security
HOWTO patch kibana for security reason
HOWTO generate certificates
HOWTO test certificates for tls
HOWTO configure kibana and apache for external customer
HOWTO use kibana with keycloak on the standalone
HOWTO make java listen to priviledged ports
Platform Service
Platform Service
HOWTO check Shiva services
HOWTO check Shiva kafka topics and assignements
Deployment
Deployment
HOWTO deploy ceph
HOWTO deploy an external library
HOWTO switch of elasticsearch version with the deployer
HOWTO expand a kafka cluster
HOWTO remove a kibana chroot
HOWTO update a platform
HOWTO bind spark ui to an other address
HOW TO deploy collectors
Management
Management
HOWTO add a new punchplatform operator
HOWTO shutdown a punchplatform
HOWTO restart an elasticsearch cluster
HOWTO remove channel or tenant
HOWTO check nodes list and nodes status in an elasticsearch cluster
HOW TO Check or troubleshoot zookeeper cluster and servers status
Monitoring
Monitoring
HOWTO configure nagios to supervised platform status
HOWTO contact punchplatform level 3 support
HOWTO configure nagios to supervised channel status
HOWTO graph eps on kibana
HOWTO supervise customer equipments
HOWTO supervise ceph cluster
Alerting
Alerting
HOWTO use Elastalert in development mode
Contribution Guide
Contribution Guide
Contributing to the Punch
Collaborative Tools
Submitting blog post
Developper Guide
Developper Guide
Setup environment
Setup environment
Install Java using Jenv
Install Maven
Install Python using Pyenv
Graphical charter
IntelliJ Debugging Tips
Eclipse Debuging Tips
Guidelines
Guidelines
Git Guideline
Build Guideline
Languages
Languages
Bash Guideline
Java Guideline
Javascript Guideline
Log Management
Log Management
Standard Parsers
Event Normalisation
Event Classification
Parser Development
Parser Configuration Tree
Product
Product
Roadmap
Releases Management
Releases Management
Licenses
Release Lifecycle
Version Control Usages
Version Control Procedures
Security Issues
Security Issues
Compilers
Security Issues
Security Audit
Security Checklist
Punch Team Services
Punch Team Services
Professional Services
Punch Service Offerings
Going with the Punch
Going with the Punch
Project Checklist
Validation
Validation
Overview
Manual Test Suite
Automatic Validation
Test Reports
Release Notes
Release Notes
6.4
6.4
DAVE-6.4.4 release notes
DAVE-6.4.3 release notes
DAVE-6.4.2 release notes
DAVE-6.4.1 release notes
DAVE-6.4.0 release notes
6.3
6.3
DAVE-6.3.4 release notes
DAVE-6.3.3 release notes
DAVE-6.3.2 release notes
DAVE-6.3.1 release notes
DAVE-6.3.0 release notes
6.2
6.2
DAVE-6.2.2 release notes
DAVE-6.2.1 release notes
DAVE-6.2.0 release notes
6.1
6.1
DAVE-6.1.1 release notes
DAVE-6.1.0 release notes
6.0
6.0
DAVE 6.0.1
DAVE 6.0.0
Test Reports
¶
Unit Tests Report
Robot Report