Differential D25007 Diff 23 src/docs/user/userguide/multimeter.diviner

Changeset View

Standalone View

src/docs/user/userguide/multimeter.diviner

	@title Multimeter User Guide			@title Multimeter User Guide
	@group userguide			@group userguide

	Using Multimeter, a sampling profiler.			Using Multimeter, a sampling profiler.

	Overview			Overview
	========			========

	IMPORTANT: This document describes a prototype application.			IMPORTANT: This document describes a prototype application.

	Multimeter is a sampling profiler that can give you coarse information about			Multimeter is a sampling profiler that can give you coarse information about
	Phabricator resource usage. In particular, it can help quickly identify sources			Phorge resource usage. In particular, it can help quickly identify sources
	of load, like bots or scripts which are making a very large number of requests.			of load, like bots or scripts which are making a very large number of requests.

	Configuring and Using Multimeter			Configuring and Using Multimeter
	================================			================================

	To access Multimeter, go to {nav Applications > Multimeter}.			To access Multimeter, go to {nav Applications > Multimeter}.

	By default, Multimeter samples 0.1% of pages. This should be a reasonable rate			By default, Multimeter samples 0.1% of pages. This should be a reasonable rate
	for most installs, but you can increase or decrease the rate by adjusting			for most installs, but you can increase or decrease the rate by adjusting
	`debug.sample-rate`. Increasing the rate (by setting the value to a lower			`debug.sample-rate`. Increasing the rate (by setting the value to a lower
	number, like 100, to sample 1% of pages) will increase the granularity of the			number, like 100, to sample 1% of pages) will increase the granularity of the
	data, at a small performance cost.			data, at a small performance cost.

	Using Multimeter			Using Multimeter
	================			================

	Multimeter shows you what Phabricator has spent time doing recently. By			Multimeter shows you what Phorge has spent time doing recently. By
	looking at the samples it collects, you can identify major sources of load			looking at the samples it collects, you can identify major sources of load
	or resource use, whether they are specific users, pages, subprocesses, or			or resource use, whether they are specific users, pages, subprocesses, or
	other types of activity.			other types of activity.

	By identifying and understanding unexpected load, you can adjust usage patterns			By identifying and understanding unexpected load, you can adjust usage patterns
	or configuration to make better use of resources (for example, rewrite bots			or configuration to make better use of resources (for example, rewrite bots
	that are making too many calls), or report specific, actionable issues to the			that are making too many calls), or report specific, actionable issues to the
	upstream for resolution.			upstream for resolution.

	The main screen of Multimeter shows you everything Phabricator has spent			The main screen of Multimeter shows you everything Phorge has spent
	resources on recently, broken down by action type. Categories are folded up			resources on recently, broken down by action type. Categories are folded up
	by default, with "(All)" labels.			by default, with "(All)" labels.

	To filter by a dimension, click the link for it. For example, from the main			To filter by a dimension, click the link for it. For example, from the main
	page, you can click "Web Request" to filter by only web requests. To expand a			page, you can click "Web Request" to filter by only web requests. To expand a
	grouped dimension, click the "(All)" link.			grouped dimension, click the "(All)" link.

	For example, suppose we suspect that someone is running a bot that is making			For example, suppose we suspect that someone is running a bot that is making
	▲ Show 20 Lines • Show All 52 Lines • Show Last 20 Lines