NSAmelchev commented on a change in pull request #8663: URL: https://github.com/apache/ignite/pull/8663#discussion_r559108405
########## File path: docs/_docs/monitoring-metrics/performance-statistics.adoc ########## @@ -0,0 +1,97 @@ +// Licensed to the Apache Software Foundation (ASF) under one or more +// contributor license agreements. See the NOTICE file distributed with +// this work for additional information regarding copyright ownership. +// The ASF licenses this file to You under the Apache License, Version 2.0 +// (the "License"); you may not use this file except in compliance with +// the License. You may obtain a copy of the License at +// +// http://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. += Performance statistics + +WARNING: This feature is experimental and may change in future releases. + +== Overview + +Ignite provides a built-in tool for cluster profiling. + +You can link:#collecting-statistics[collect] performance statistics from the cluster and then +link:#building-the-report[build] the performance report. + +== Collecting statistics + +link:#jmx[JMX interface] is used to start and stop statistics collecting. + +Each node collects performance statistics in a binary file. This file is placed under +`Ignite_work_directory/perf_stat/` directory. The name mask is `node-{nodeId}-{index}.prf`. + +Performance statistics files are used to build the report offline. + +Nodes use off-heap cyclic buffer to temporarily store serialized statistics. The writer thread flushes buffer to the +file when the flush size is reached. Some statistics will be skipped if the buffer overflows due to a slow disk. See +the link:#system-properties[properties] section for customization. + +Each statistics collection process creates a new file on nodes. Each next file has the same name with the +corresponding index: + + node-faedc6c9-3542-4610-ae10-4ff7e0600000.prf + node-faedc6c9-3542-4610-ae10-4ff7e0600000-1.prf + node-faedc6c9-3542-4610-ae10-4ff7e0600000-2.prf Review comment: Fixed. ---------------------------------------------------------------- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. For queries about this service, please contact Infrastructure at: [email protected]
