Home
Home
German Version
Support
Impressum
25.2 Release ►

Start Chat with Collection

    Main Navigation

    • Preparation
      • Connectors
      • Create an InSpire VM on Hyper-V
      • Initial Startup for G7 appliances
      • Setup InSpire G7 primary and Standby Appliances
    • Datasources
      • Configuration - Atlassian Confluence Connector
      • Configuration - Best Bets Connector
      • Configuration - Box Connector
      • Configuration - COYO Connector
      • Configuration - Data Integration Connector
      • Configuration - Documentum Connector
      • Configuration - Dropbox Connector
      • Configuration - Egnyte Connector
      • Configuration - GitHub Connector
      • Configuration - Google Drive Connector
      • Configuration - GSA Adapter Service
      • Configuration - HL7 Connector
      • Configuration - IBM Connections Connector
      • Configuration - IBM Lotus Connector
      • Configuration - Jira Connector
      • Configuration - JVM Launcher Service
      • Configuration - LDAP Connector
      • Configuration - Microsoft Azure Principal Resolution Service
      • Configuration - Microsoft Dynamics CRM Connector
      • Configuration - Microsoft Exchange Connector
      • Configuration - Microsoft File Connector (Legacy)
      • Configuration - Microsoft File Connector
      • Configuration - Microsoft Graph Connector
      • Configuration - Microsoft Loop Connector
      • Configuration - Microsoft Project Connector
      • Configuration - Microsoft SharePoint Connector
      • Configuration - Microsoft SharePoint Online Connector
      • Configuration - Microsoft Stream Connector
      • Configuration - Microsoft Teams Connector
      • Configuration - Salesforce Connector
      • Configuration - SCIM Principal Resolution Service
      • Configuration - SemanticWeb Connector
      • Configuration - ServiceNow Connector
      • Configuration - Web Connector
      • Configuration - Yammer Connector
      • Data Integration Guide with SQL Database by Example
      • Indexing user-specific properties (Documentum)
      • Installation & Configuration - Atlassian Confluence Sitemap Generator Add-On
      • Installation & Configuration - Caching Principal Resolution Service
      • Installation & Configuration - Mindbreeze InSpire Insight Apps in Microsoft SharePoint On-Prem
      • Mindbreeze InSpire Insight Apps in Microsoft SharePoint Online
      • Mindbreeze Web Parts for Microsoft SharePoint
      • User Defined Properties (SharePoint 2013 Connector)
      • Whitepaper - Mindbreeze InSpire Insight Apps in Salesforce
      • Whitepaper - Web Connector - Setting Up Advanced Javascript Usecases
    • Configuration
      • CAS_Authentication
      • Configuration - Alerts
      • Configuration - Alternative Search Suggestions and Automatic Search Expansion
      • Configuration - Back-End Credentials
      • Configuration - Chinese Tokenization Plugin (Jieba)
      • Configuration - CJK Tokenizer Plugin
      • Configuration - Collected Results
      • Configuration - CSV Metadata Mapping Item Transformation Service
      • Configuration - Entity Recognition
      • Configuration - Exporting Results
      • Configuration - External Query Service
      • Configuration - Filter Plugins
      • Configuration - GSA Late Binding Authentication
      • Configuration - Identity Conversion Service - Replacement Conversion
      • Configuration - InceptionImageFilter
      • Configuration - Index-Servlets
      • Configuration - InSpire AI Chat and Insight Services for Retrieval Augmented Generation
      • Configuration - Item Property Generator
      • Configuration - Japanese Language Tokenizer
      • Configuration - Kerberos Authentication
      • Configuration - Management Center Menu
      • Configuration - Metadata Enrichment
      • Configuration - Metadata Reference Builder Plugin
      • Configuration - Mindbreeze Proxy Environment (Remote Connector)
      • Configuration - Personalized Relevance
      • Configuration - Plugin Installation
      • Configuration - Principal Validation Plugin
      • Configuration - Profile
      • Configuration - Reporting Query Logs
      • Configuration - Reporting Query Performance Tests
      • Configuration - Request Header Session Authentication
      • Configuration - Shared Configuration (Windows)
      • Configuration - Vocabularies for Synonyms and Suggest
      • Configuration of Thumbnail Images
      • Cookie-Authentication
      • Documentation - Mindbreeze InSpire
      • I18n Item Transformation
      • Installation & Configuration - Outlook Add-In
      • Installation - GSA Base Configuration Package
      • JWT Authentication
      • Language detection - LanguageDetector Plugin
      • Mindbreeze Personalization
      • Mindbreeze Property Expression Language
      • Mindbreeze Query Expression Transformation
      • SAML-based Authentication
      • Trusted Peer Authentication for Mindbreeze InSpire
      • Using the InSpire Snapshot for Development in a CI_CD Scenario
      • Whitepaper - AI Chat
      • Whitepaper - Create a Google Compute Cloud Virtual Machine InSpire Appliance
      • Whitepaper - Create a Microsoft Azure Virtual Machine InSpire Appliance
      • Whitepaper - Create AWS 10M InSpire Appliance
      • Whitepaper - Create AWS 1M InSpire Appliance
      • Whitepaper - Create AWS 2M InSpire Appliance
      • Whitepaper - Create Oracle Cloud 10M InSpire Application
      • Whitepaper - Create Oracle Cloud 1M InSpire Application
      • Whitepaper - MMC_ Services
      • Whitepaper - Natural Language Question Answering (NLQA)
      • Whitepaper - SSO with Microsoft AAD or AD FS
      • Whitepaper - Text Classification Insight Services
    • Operations
      • Adjusting the InSpire Host OpenSSH Settings - Set LoginGraceTime to 0 (Mitigation for CVE-2024-6387)
      • app.telemetry Statistics Regarding Search Queries
      • CIS Level 2 Hardening - Setting SELinux to Enforcing mode
      • Configuration - app.telemetry dashboards for usage analysis
      • Configuration - Usage Analysis
      • Deletion of Hard Disks
      • Handbook - Backup & Restore
      • Handbook - Command Line Tools
      • Handbook - Distributed Operation (G7)
      • Handbook - Filemanager
      • Handbook - Indexing and Search Logs
      • Handbook - Updates and Downgrades
      • Index Operating Concepts
      • Inspire Diagnostics and Resource Monitoring
      • Provision of app.telemetry Information on G7 Appliances via SNMPv3
      • Restoring to As-Delivered Condition
      • Whitepaper - Administration of Insight Services for Retrieval Augmented Generation
    • User Manual
      • Browser Extension
      • Cheat Sheet
      • iOS App
      • Keyboard Operation
    • SDK
      • api.chat.v1beta.generate Interface Description
      • api.v2.alertstrigger Interface Description
      • api.v2.export Interface Description
      • api.v2.personalization Interface Description
      • api.v2.search Interface Description
      • api.v2.suggest Interface Description
      • api.v3.admin.SnapshotService Interface Description
      • Debugging (Eclipse)
      • Developing an API V2 search request response transformer
      • Developing Item Transformation and Post Filter Plugins with the Mindbreeze SDK
      • Development of a Query Expression Transformer
      • Development of Insight Apps
      • Embedding the Insight App Designer
      • Java API Interface Description
      • OpenAPI Interface Description
    • Release Notes
      • Release Notes 20.1 Release - Mindbreeze InSpire
      • Release Notes 20.2 Release - Mindbreeze InSpire
      • Release Notes 20.3 Release - Mindbreeze InSpire
      • Release Notes 20.4 Release - Mindbreeze InSpire
      • Release Notes 20.5 Release - Mindbreeze InSpire
      • Release Notes 21.1 Release - Mindbreeze InSpire
      • Release Notes 21.2 Release - Mindbreeze InSpire
      • Release Notes 21.3 Release - Mindbreeze InSpire
      • Release Notes 22.1 Release - Mindbreeze InSpire
      • Release Notes 22.2 Release - Mindbreeze InSpire
      • Release Notes 22.3 Release - Mindbreeze InSpire
      • Release Notes 23.1 Release - Mindbreeze InSpire
      • Release Notes 23.2 Release - Mindbreeze InSpire
      • Release Notes 23.3 Release - Mindbreeze InSpire
      • Release Notes 23.4 Release - Mindbreeze InSpire
      • Release Notes 23.5 Release - Mindbreeze InSpire
      • Release Notes 23.6 Release - Mindbreeze InSpire
      • Release Notes 23.7 Release - Mindbreeze InSpire
      • Release Notes 24.1 Release - Mindbreeze InSpire
      • Release Notes 24.2 Release - Mindbreeze InSpire
      • Release Notes 24.3 Release - Mindbreeze InSpire
      • Release Notes 24.4 Release - Mindbreeze InSpire
      • Release Notes 24.5 Release - Mindbreeze InSpire
      • Release Notes 24.6 Release - Mindbreeze InSpire
      • Release Notes 24.7 Release - Mindbreeze InSpire
      • Release Notes 24.8 Release - Mindbreeze InSpire
      • Release Notes 25.1 Release - Mindbreeze InSpire
      • Release Notes 25.2 Release - Mindbreeze InSpire
    • Security
      • Known Vulnerablities
    • Product Information
      • Product Information - Mindbreeze InSpire - Standby
      • Product Information - Mindbreeze InSpire
    Home

    Path

    Sure, you can handle it. But should you?
    Let our experts manage the tech maintenance while you focus on your business.
    See Consulting Packages

    InSpire Diagnostics and Resource Monitoring
    Diagnostics & Monitoring

    Creating Java Heap DumpsPermanent link for this heading

    Tool JMX Terminal Permanent link for this heading

    The "JMX Terminal" tool allows you to query and execute JMX Beans. The tool can be found under /opt/mindbreeze/tools/jmxterm-uber.jar or under C:\Program Files\Mindbreeze\Enterprise Search\Server\Tools\jmxterm-uber.jar. The tool contains an interactive shell with integrated help.

    Starting the Tools:

    cd /opt/mindbreeze/tools/

    java -jar jmxterm-uber.jar

    The interactive shell starts.

    Note: On Windows, make sure that the Java JDK is used.

    Creating Heap DumpsPermanent link for this heading

    The following information is necessary for a heap dump:

    • PID (for Java sandboxes, such as Item Transformer, Query Transformer) or JMX URL (for Client Service or Query Service)
    • Directory for storing the heap dumps

    Note: The JMX URL is output in the log file of the corresponding service. For example:

    TomcatLauncher INFO: Started JMX Server on address service:jmx:rmi://localhost/jndi/rmi://localhost:41518/jmxrmi

    The dumps are created with the JMX terminal. Execute the following commands inside the InSpire container:

    # starting the tool

    cd /opt/mindbreeze/tools/

    java -jar jmxterm-uber.jar

    # Welcome to JMX terminal. Type "help" for available commands.

    $> # connect to the service via PID

    $>open 12345

    $> # alternative: connect to the service via JMX URL

    $>open service:jmx:rmi://localhost/jndi/rmi://localhost:41518/jmxrmi

    # Connection to service:jmx:rmi://localhost/jndi/rmi://localhost:41518/jmxrmi is opened

    $> # set the domain:

    $>domain com.sun.management

    $> # set the bean:

    $>bean com.sun.management:type=HotSpotDiagnostic

    $> # execute the dumpHeap operation to the path e.g. /data/clientservice.hprof

    $>run dumpHeap /data/clientservice.hprof true
    # calling operation dumpHeap of mbean com.sun.management:type=HotSpotDiagnostic with params [/data/clientservice.hprof, true]
    # operation returns:
    null

    Then, you can find the heap dump under /data/clientservice.hprof

    Monitoring JMX Values into a CSVPermanent link for this heading

    The JMX terminal can request values from JMX MBean attributes.

    The following example shows the query of java.lang.Memory.HeapMemoryUsage:

    # starting the tool

    cd /opt/mindbreeze/tools/

    java -jar jmxterm-uber.jar

    Welcome to JMX terminal. Type "help" for available commands.

    $> # connect to the service via PID

    $>open 12345

    $> # alternative: connect to the service via JMX URL

    $>open service:jmx:rmi://localhost/jndi/rmi://localhost:41518/jmxrmi

    #Connection to service:jmx:rmi://localhost/jndi/rmi://localhost:41518/jmxrmi is opened

    $> # set the domain:

    $>domain java.lang

    $> # set the bean:

    $>bean java.lang:type=Memory

    $> # execute the dumpHeap operation to the path e.g. /data/clientservice.hprof

    $>get HeapMemoryUsage

    HeapMemoryUsage = {

      committed = 1558708224;

      init = 262144000;

      max = 3702521856;

      used = 208660496;

    };

    Collect performance data with the Collect scriptPermanent link for this heading

    /opt/mindbreeze/scripts/collect.sh

    The Collect script collects the following information:

    • all memory-usage.csv files from the current log directory
    • Heap dumps of all mes-jvms (mesclientservice, mesindex, messdkjavaservice)
    • Thread dumps and native thread dumps of these processes
    • Perf report using perf record and perf script for 10 seconds
    • Jvmtop Report with optional profiling

    The collected information is stored in a tar.gz file in /data/collect

    usage: collect.py [-h] [--output_dir OUTPUT_DIR] [--tarname TARNAME]

                      [--no-compress-tar] [--perf | --no-perf]

                      [--perf-time PERF_TIME] [--jvmtop | --no-jvmtop]

                      [--jvmtop-profile] [--jvmtop-iterations JVMTOP_ITERATIONS]

                      [--jvmtop-delay JVMTOP_DELAY]

    Tool to collect resource usage information

    optional arguments:

      -h, --help            show this help message and exit

      --output_dir OUTPUT_DIR, -o OUTPUT_DIR

                            base directory for collect reports (default:

                            /data/collect)

      --tarname TARNAME     filename of output file (default:

                            2019-05-22_10-02-27.tar)

      --no-compress-tar     do not compress the output tarfile

      --perf                collect 'perf' information (default)

      --no-perf             do not collect 'perf' information

      --perf-time PERF_TIME

                            'perf' collection time in seconds (default: 2)

      --jvmtop              collect 'jvmtop' information

      --no-jvmtop           do not collect 'jvmtop' information (default)

      --jvmtop-profile      enable profiling when collecting jvmtop information

      --jvmtop-iterations JVMTOP_ITERATIONS

                            number of iteration for 'jvmtop' (default: 5)

      --jvmtop-delay JVMTOP_DELAY

                            delay (in seconds) between iterations of 'jvmtop'

                            (default: 1)

    Monitoring of Resources with CSV FilesPermanent link for this heading

    Monitoring the IndexPermanent link for this heading

    In the section „Memory Analysis Settings“ oft he Index, monitoring of resources can be configured.

    The Index Service will generate a memory.csv file in the log directory of the Index Service.

    Monitoring the Client ServicePermanent link for this heading

    In the section „Memory Analysis Settings“ of the Client Service , monitoring of resources can be configured.

    The Client Service will generate a memory.csv file in the log directory of the Client Service.

    Setting the level for loggingPermanent link for this heading

    Select the Log LevelPermanent link for this heading

    The configuration in the log pool includes the configuration "Permanent Software Telemetry Log Level"

    The different levels are Log, Standard, Detail and Debug, where “Log” is the lowest and “Debug” is the highest level. Depending on the selection, all or certain sub-areas are now logged.

    Download PDF

    • Inspire Diagnostics and Resource Monitoring

    Content

    • Creating Java Heap Dumps
    • Collect performance data with the Collect script
    • Monitoring of Resources with CSV Files
    • Setting the level for logging

    Download PDF

    • Inspire Diagnostics and Resource Monitoring