Skip to content

Platform Configuration

When the platform deployment is completed, some post-install configuration update are required. The PunchPlatform team created a set of resource that you must set up to be production ready. The main purpose of these actions is to provide resources which use full platform logs in order to monitor Punchplatform in production. Here are the dedicated actions to Elasticsearch and Kibana

From the root folder of the unzipped deployer (e.g. 'punchplatform-deployment-X.Y.Z'), the Elasticsearch and Kibana related resources are located at:

punchplatform-deployment-5.4.0
└── resources/
    ├── elasticsearch
    │   └── templates
    │       └── platform
    │           ├── mapping_archive.json
    │           ├── mapping_jobs.json
    │           ├── mapping_platform_health.json
    │           ├── mapping_platform_logs.json
    │           ├── mapping_platform_monitoring.json
    │           ├── mapping_platform_refresh_interval.json
    │           ├── mapping_pml.json
    │           └── mapping_topology_metrics.json
    └── kibana
        └── dashboards
            ├── archiving_monitoring
            │   └── archive_monitoring.json
            ├── platform_monitoring
            │   └── platform_monitoring.json
            ├── spark_monitoring
            │   └── spark_monitoring.json
            └── tenants_monitoring
                └── tenants_monitoring.json

Elasticsearch Templates

The template mapping that you must load are the ones under the "platform" directory. They are needed to correctly insert the monitoring events generated by the PunchPlatform itself.

To do so, you can do it by hand using this command for each file:

$ curl -H "Content-Type: application/json" -XPUT localhost:9200/_template/mapping_metrics -d @mapping_metrics.json

Or you can load them all at once using the dedicated punchplatform-push-es-templates.sh command:

$ punchplatform-push-es-templates.sh --directory resources/elasticsearch/templates/platform --url http://localhost:9200 --verbose

Kibana Dashboards

The PunchPlatform comes with already made custom Kibana dashboard to easily monitor your platform All these dashboards are available under the "dashboards" directory

To import the dashboards you can use this command-line:

punchplatform-setup-kibana.sh --import 

Or manually, follow these quick steps:

  1. Go to Kibana UI
  2. On the left-side panel, go to the "Management > Saved Objects > Import"
  3. Drag-n-drop or select the previous NDJSON file
  4. Go to the "Dashboard" tab and start exploring your dashboards !

You can get information about these dashboards here : Punch Dashboards