Skip to content

Punch Documentation Graphical charter

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
- 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
- Deployer Getting Started
  Deployer Getting Started
- 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
Reference Guide
Reference Guide
- Overview
- Configuration
  Configuration
  - Overview
  - Channels
  - Books
  - Punchlines
  - Plans
  - Punch templates
- 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
- 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
- Alerting
  Alerting
  - Overview
  - Punch Modules
- Application Scheduling
  Application Scheduling
  - Shiva Application Scheduler
  - Shiva Protocol
- REST Gateway
  REST Gateway
- Manual Pages
  Manual Pages
- Nifi Punch Processor
Development Guide
Development Guide
- Overview
- Custom Nodes
  Custom Nodes
- Custom Shiva Applications
  Custom Shiva Applications
  - Java Custom Application
  - Python Custom Application
- Elastalert Custom Modules
- User Defined Functions
- Punch Programming
  Punch Programming
Operation Guides
Operation Guides
- Overview
- Management
  Management
- 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
- 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
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 Graphical charter
    Table of contents
    
    Colors
    
    Font
    
    Logos:
  - IntelliJ Debugging Tips
  - Eclipse Debuging Tips
  - Guidelines
    Guidelines
    
    Git Guideline
    
    Build Guideline
    
    Languages
    Languages
    
    Bash Guideline
    
    Java Guideline
    
    Javascript Guideline
Log Management
Log Management
Product
Product
- Roadmap
- Releases Management
  Releases Management
- Security Issues
  Security Issues
- Punch Team Services
  Punch Team Services
  - Professional Services
  - Punch Service Offerings
- Going with the Punch
  Going with the Punch
  - Project Checklist
- Validation
  Validation
- Release Notes
  Release Notes
  - 6.4
    6.4
    
    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
  - 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

Table of contents

Colors
Font
Logos:

Graphical charter

Colors¶

Red - #e25266

Blue - #1575a8

Yellow - #e1ae34

green - #25a982

Font¶

Name: Open Sans

Logos:¶

Previous Install Python using Pyenv

Next IntelliJ Debugging Tips

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