The Talon Manual

Skip to end of metadata
Go to start of metadata

SINCE 3.4

Up until the 3.4 release the StatsDumpTool was maintained in [GitHub|https://github.com/neeveresearch/nvx-platform-tools/tree/master/nvx-stats-dump-tool]. This was done to make it easier to keep the tool up to date with new stats added to the platform.

In This Section

Overview

 

This page lists the usage info for the X Platform stats dump tool.

This tool can read a binary transaction log containing server heartbeats emitted by a Talon Server and write them out in a human readable format. Computing and tracing statistics from the running application process results in cpu overhead and garbage. As a lower cost alternative Talon server can be configured to log its server heartbeats to a transaction log, and this tool can be used to compute and trace the binary stats in a separate process (possibly on another host).

Each heartbeat message includes the following stats:

  • System Stats
    • Basic information - Server/hostname and process pid
    • GC stats - Heap Size and collection time
    • JIT Information
    • System Load average
    • Thread Count
    • Thread Stats
    • Pool Stats
  • Application Stats
    • Engine
    • UserStat
    • EventMultiplexer
    • StoreBinding
    • StoreBindingPersister
    • StoreBindingICRSender
    • BusBinding Stats


The platform allows fairly granular control over which portions of the above stats are collected to provide the ability to control the associated overhead with collecting them. See AEP Engine Statistics for information on enabling collection of these statistics. 

Basic Usage

Requirement

In order to use this tool, Binary Heartbeat Logging must have been enabled on the application in question. Even if you have enabled stats collection, but did not enable the hearbeat logging, you will not be able to retrieve said statistics at a later date.

Running the Tool

From a distribution

From a jar only distribution

Querying records within a time range

You can query for records in a time range by specifying --startDate or --endDate or both:

  • If only --startDate is specified, stats records are dumped from startDate to the end of the file is reached.
  • If only --endDate is specified, stats records are dumped from beginning of the file till the endDate.
  • If both --startDate and --endDate are specified, stats are dumped in between the given start and end dates.

The format for specifying the timestamps used with --startDate and --endDate is yyyy-MM-dd HH:mm:ss.

Be careful when specifying these timestamps! Leading/trailing spaces or additional spaces between date and time block might cause them to not be parsed correctly.

Examples

All records

Here is the output of running the stats dump tool on a sample transaction log file:

The output shows that the tool has read 2,619 records and written them to the output file (stats.txt). Note that the output file is created in the same directory as the input file.

All records within a date range

Here is an example of how using --startDate can be used filter out records.

Notice that because we specified --startDate here, only 99 records are written (of the 2,619 records in the transaction log).

You can further filter records by specifying a time range with a particular --startDate and --endDate. In the example below we are querying records starting between "2016-01-27 00:00:00" and "2016-01-27 01:26:39":

Notice only 8 records are written to the output file.

 

  • No labels