Punch Documentation Javadoc
Type to start searching
    Official website
    • Home
    • Tutorial
    • Solutions
    • Reference Guide
    • Development Guide
    • Operation Guides
    • Contribution Guide
    • Log Management
    • Product
      • Welcome
        • Architecture
        • Security
        • Modularity
        • Rationale
        • PunchPlatform versus ELK
        • Punch components
        • Punchlines
        • Applications
        • Plans
        • Channels
        • Books
        • Tenants
        • Platform
        • Glossary
        • Enablers
        • Feature List
      • Tutorials
        • 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
        • Before you start
        • Deploy the platform
        • COTS
        • Punch Operator
        • Shiva
        • Training Modules
          • Overview
          • A Punch Business and Functional Perspective
          • Punch Components and concepts
          • Conclusion
          • Overview
          • Punchlines
          • Applications
          • Channels
          • Overview
          • Punch Components
          • Punch Design Patterns and Reference Architecture
          • Design Issues Highlights
          • Overview
          • Health/Status tools
          • Frequent Operation Tasks
          • Troubleshooting basics
          • Overview
          • Deployment process
          • Platform runtime configuration
          • Patching and Ansible inventory usage
          • Upgrade procedure
          • Overview
          • Monitoring the Punch platform components
          • Monitoring the channels and applications
          • Investigating the channel problems
          • Overview
          • Indexing Fundamentals
          • Kibana Discover, with queries and filters
          • Kibana Visualizations, with aggregations
          • Kibana Dashboards
          • General best practices
          • Punch Kibana plugin
          • Overview
          • Punch Language Fundamentals
          • Punchlets
          • Operators
          • Resources
          • Error Handling
          • Data Streams
          • Going production
          • 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
      • Archiving
      • Aggregations
      • Monitoring
      • Geospatial
      • Data Simulation
      • Overview
        • Overview
        • Channels
        • Books
        • Punchlines
        • Plans
        • Punch templates
        • ChannelCtl
        • PlanCtl
        • PlatformCtl
        • KafkaCtl
        • BookCtl
          • Configuration
              • Extraction Input
              • File
              • Generator
              • HTTP
              • Kafka
              • Lumberjack
              • Azure Blob Storage
              • NSG Azure Blob Storage
              • Syslog
              • SNMP
              • SFTP
              • SMTP
              • Archive Reader
              • Punch
              • Filter Node
              • Rythmer Node
              • Elasticsearch
              • File
              • File Transfer
              • Kafka
              • Lumberjack
              • MapD
              • Clickhouse
              • PostgreSQL
              • Syslog Tcp
              • Syslog Udp
              • Zabbix
          • Javadocs
          • Configuration
            • Spark Primer
            • Spark Punchlines
            • User Defined Functions
            • Spark and Pyspark Dependency Management
            • Spark Network
              • 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
              • Python Elastic Output
              • Elastic Output
              • File Output
              • Kafka Batch Output
              • Kafka Stream Output
              • File Model Output
              • Show
              • Archive Reader
              • Mllib Model
              • SQL
              • Punch
              • Random Split
        • Punchlets
        • Beats
        • Internal Monitoring
        • Archiving Service
        • Archiving
        • Extracting
        • Extraction Reliability
        • CephFs Distributed FileSystem
        • Object storage operation tips
          • Punch documentation plugin
          • Data extraction plugin
          • Data feedback plugin
          • Punch Generic Dashboards
          • Punch Platform health monitoring dashboards
          • Punch application metrics monitoring dashboards
          • Kibana Troubleshooting
          • Kibana Advanced Vega
        • Overview
        • Administration
        • Audit and Traceability
        • Data Protection
        • Overview
        • Punch Modules
        • Shiva Application Scheduler
        • Shiva Protocol
        • Gateway
        • Request Filtering for forwarding
        • API Reference
        • Resource Manager
        • 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
      • Overview
        • Java Storm Custom Node
        • Java Spark Custom Node
        • Python Spark Custom Node
        • Java Custom Application
        • Python Custom Application
      • Elastalert Custom Modules
      • User Defined Functions
        • Javadoc
        • Punchlang
        • Tuples
        • Operators
        • Grok
        • Dissect
        • Punchlets
        • Punchline Integration
        • Exception Handling
        • Tutorial Write a Log Parser
        • Tutorial Write a Production Grade Parser
      • Overview
        • Components Administration Commands
        • Applicative Administration Commands
        • Developer and Testing Commands
        • Reference Architecture overview
          • Log Collector (LTR)
          • Platform Events Forwarder Punchline
          • Log Central (LMC)
          • Central Receiver Punchlines
          • Central Processor Punchlines
          • Central Indexer Punchlines
          • Central Archiver Punchlines
          • Platform Events Dispatcher Punchlines
        • Shiva
        • Operator
        • Gateway
        • Spark
        • Storm
        • Deployment Process
          • Requirements for deployment and target servers
          • Debian based setup
          • CentOS based setup
          • Darwin setup
          • punchplatform-deployment.settings
          • Runtime resolver configuration (resolv.yaml)
        • Punch Framework Deployer Guide
          • Post-deployment additional platform Configuration
          • Tenant Configuration
        • Patch Procedure
        • Monitoring Guide
        • Platform Monitoring
        • Channels Monitoring
          • Metrics Overview
          • Metrics/Events Reporters
          • Platform Metrics
          • Metrics in Apache Storm
          • Metrics/logs in Apache Spark
        • Logging
        • Elastalert
        • Elasticsearch Housekeeping
        • Archives Housekeeping
          • 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
        • 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 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
          • TROUBLESHOOTING Timelion
          • TROUBLESHOOTING kibana define default index pattern error
          • 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
          • Troubleshooting handling compressed logs
          • Troubleshooting a punchlet
          • Troubleshooting Punchlet slow processing
          • Troubleshooting Dangling Meta Character
          • TROUBLESHOOTING cast errors pml model
          • TROUBLESHOOTING structured streaming
          • 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
          • TROUBLESHOOTING invalid lumberjack version
          • TROUBLESHOOTING empty metrics indices
          • TROUBLESHOOTING could not find nimbus from seed hosts
          • TROUBLESHOOTING Cope with Out Of Memory java crashes
          • TROUBLESHOOTING kibana standalone
          • TROUBLESHOOTING Unsupported major minor version
          • TROUBLESHOOTING STANDALONE
          • TROUBLESHOOTING Opendistro Security
          • 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
          • HOWTO emit multiple events from a punchlet
          • HOWTO develop punchlets in sublime text
          • HOWTO test a parser before going to production
          • HOWTO add your analytics algorithm
          • HOWTO activate logging
          • 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
          • HOWTO configure kibana plugin
          • 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
          • HOWTO check Shiva services
          • HOWTO check Shiva kafka topics and assignements
          • 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
          • 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
          • 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
          • HOWTO use Elastalert in development mode
      • Contributing to the Punch
      • Collaborative Tools
      • Submitting blog post
          • Install Java using Jenv
          • Install Maven
          • Install Python using Pyenv
        • Graphical charter
        • IntelliJ Debugging Tips
        • Eclipse Debuging Tips
          • Git Guideline
          • Build Guideline
            • Bash Guideline
            • Java Guideline
            • Javascript Guideline
      • Standard Parsers
      • Event Normalisation
      • Event Classification
      • Parser Development
      • Parser Configuration Tree
      • Roadmap
        • Licenses
        • Release Lifecycle
        • Version Control Usages
        • Version Control Procedures
        • Compilers
        • Security Issues
        • Security Audit
        • Security Checklist
        • Professional Services
        • Punch Service Offerings
        • Project Checklist
        • Overview
        • Manual Test Suite
        • Automatic Validation
        • Test Reports
          • DAVE-6.4.5 release notes
          • 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
          • 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
          • DAVE-6.2.2 release notes
          • DAVE-6.2.1 release notes
          • DAVE-6.2.0 release notes
          • DAVE-6.1.1 release notes
          • DAVE-6.1.0 release notes
          • DAVE 6.0.1
          • DAVE 6.0.0

    Javadoc

    Javadoc

    Previous User Defined Functions
    Next Punchlang
    2018, Thales Services SAS, France
    powered by MkDocs and Material for MkDocs
    6.4.5-SNAPSHOT
    HEAD (2a2a0ea317)
    2023-04-27 14:41
    Punchplatform product documentation