Credit to devdocs.io
Back
Forward
Menu
Home
Clear search
graphite
API Mirror
graphite
2
Administering Carbon
Administering Carbon
Starting Carbon
2
Administering The Webapp
Administering The Webapp
nginx + gunicorn
5
Alternative storage finders
Advanced finders
Alternative storage finders
Built-in finders
Custom finders
Installing custom finders
1
Apache + mod_wsgi
Running the webapp with mod_wsgi as URL-prefixed application (Apache)
2
Authentication Configuration
LDAP
Other Authentications
6
Client APIs
Client APIs
Cubism.js
Graphitejs
Scales
Structured Metrics
txCarbonClient
8
Configuring Carbon
aggregation-rules.conf
carbon.conf
Configuring Carbon
relay-rules.conf
rewrite-rules.conf
storage-aggregation.conf
storage-schemas.conf
whitelist and blacklist
4
Configuring The Webapp
Apache + mod_wsgi
Configuring The Webapp
nginx + gunicorn
Nginx + uWSGI
6
Creating or Modifying a Dashboard
Adding a Graph
Deleting a Graph
Importing a Graph
Multiple Metrics - Combining Graphs
Re-ordering Graphs
Saving the Dashboard
4
Customizing Graphs
Customizing a Single Metric Element
Customizing the Whole Graph
Other Operations on the Graph
Paths and Wildcards
2
Data Display Formats
format
rawData
3
Database Storage
HTTP(S) TagDB
Local Database TagDB
Redis TagDB
2
Default Installation Layout
Carbon and Graphite-web
Whisper
14
FAQ
Does Graphite use RRDtool?
FAQ
How do I report problems or request features for Graphite?
How real-time are the graphs?
How scalable is Graphite?
Is there a diagram of Graphite’s architecture?
Is this Graphite related to the SIL font rendering graphite?
Is this Graphite related to the sourceforge project called graphite?
What is Graphite written in?
What is Graphite?
What license is Graphite released under?
Who already uses Graphite?
Who should use Graphite?
Who writes and maintains Graphite?
5
Feeding In Your Data
Existing tools and APIs
Feeding In Your Data
The pickle protocol
The plaintext protocol
Using AMQP
143
Functions
absolute()
aggregate()
aggregateLine()
aggregateWithWildcards()
alias()
aliasByMetric()
aliasByNode()
aliasByTags()
aliasQuery()
aliasSub()
alpha()
applyByNode()
areaBetween()
asPercent()
averageAbove()
averageBelow()
averageOutsidePercentile()
averageSeries()
averageSeriesWithWildcards()
cactiStyle()
changed()
color()
consolidateBy()
constantLine()
countSeries()
cumulative()
currentAbove()
currentBelow()
dashed()
delay()
derivative()
diffSeries()
divideSeries()
divideSeriesLists()
drawAsInfinite()
events()
exclude()
exponentialMovingAverage()
fallbackSeries()
filterSeries()
Function API
Function Plugins
Functions
grep()
group()
groupByNode()
groupByNodes()
groupByTags()
highest()
highestAverage()
highestCurrent()
highestMax()
hitcount()
holtWintersAberration()
holtWintersConfidenceArea()
holtWintersConfidenceBands()
holtWintersForecast()
identity()
integral()
integralByInterval()
interpolate()
invert()
isNonNull()
keepLastValue()
legendValue()
limit()
linearRegression()
linearRegressionAnalysis()
lineWidth()
List of functions
logarithm()
lowest()
lowestAverage()
lowestCurrent()
mapSeries()
maximumAbove()
maximumBelow()
maxSeries()
minimumAbove()
minimumBelow()
minMax()
minSeries()
mostDeviant()
movingAverage()
movingMax()
movingMedian()
movingMin()
movingSum()
movingWindow()
multiplySeries()
multiplySeriesWithWildcards()
nonNegativeDerivative()
nPercentile()
offset()
offsetToZero()
percentileOfSeries()
perSecond()
pieAverage()
pieMaximum()
pieMinimum()
pow()
powSeries()
randomWalkFunction()
rangeOfSeries()
reduceSeries()
removeAbovePercentile()
removeAboveValue()
removeBelowPercentile()
removeBelowValue()
removeBetweenPercentile()
removeEmptySeries()
roundFunction()
scale()
scaleToSeconds()
secondYAxis()
seriesByTag()
setXFilesFactor()
sinFunction()
smartSummarize()
sortBy()
sortByMaxima()
sortByMinima()
sortByName()
sortByTotal()
squareRoot()
stacked()
stddevSeries()
stdev()
substr()
summarize()
sumSeries()
sumSeriesWithWildcards()
threshold()
timeFunction()
timeShift()
timeSlice()
timeStack()
transformNull()
unique()
Usage
useSeriesAbove()
verticalLine()
weightedAverage()
1
Getting Started with the Dashboard Interface
Completer or browser tree?
4
Getting Your Data Into Graphite
Step 1 - Plan a Naming Hierarchy
Step 2 - Configure your Data Retention
Step 3 - Understanding the Graphite Message Format
The Basic Idea
76
Graph Parameters
areaAlpha
areaMode
bgcolor
cacheTimeout
colorList
drawNullAsZero
fgcolor
fontBold
fontItalic
fontName
fontSize
format
from
graphOnly
graphType
height
hideAxes
hideGrid
hideLegend
hideNullFromLegend
hideXAxis
hideYAxis
jsonp
leftColor
leftDashed
leftWidth
lineMode
lineWidth
localOnly
logBase
majorGridLineColor
margin
max
maxDataPoints
min
minorGridLineColor
minorY
minXStep
noCache
noNullPoints
pickle
pieLabels
pieMode
pretty
rightColor
rightDashed
rightWidth
template
thickness
title
tz
uniqueLegend
until
valueLabels
valueLabelsColor
valueLabelsMin
vtitle
vtitleRight
width
xFilesFactor
xFormat
yAxisSide
yDivisors
yLimit
yLimitLeft
yLimitRight
yMax
yMaxLeft
yMaxRight
yMin
yMinLeft
yMinRight
yStep
yStepLeft
yStepRight
yUnitSystem
3
Graphing Metrics
from / until
target
template
5
Graphite Events
Adding Events
Database Storage
Graphite Events
Managing Events in the Admin UI
Querying Events
8
Graphite Tag Support
Adding Series to the TagDB
Auto-complete Support
Carbon
Database Storage
Exploring Tags
Graphite Tag Support
Querying
Removing Series from the TagDB
1
Graphite Terminology
Graphite Terminology
11
Graphite-web’s local_settings.py
Additional Django Settings
Authentication Configuration
Cluster Configuration
Config File Location
Configure Webserver (Apache)
Dashboard Authorization Configuration
Database Configuration
Email Configuration
Filesystem Paths
General Settings
Graphite-web’s local_settings.py
5
Installing From Pip
Installing Carbon in a Custom Location
Installing Ceres
Installing From Pip
Installing Graphite-web in a Custom Location
Installing in the Default Location
4
Installing From Source
Installing Carbon in a Custom Location
Installing From Source
Installing Graphite-web in a Custom Location
Installing in the Default Location
1
Installing From Synthesize
Installing From Synthesize
10
Installing Graphite
Default Installation Layout
Dependencies
Docker
Fulfilling Dependencies
Help! It didn’t work!
Initial Configuration
Installing Graphite
Installing Graphite
Post-Install Tasks
Windows Users
5
Installing in Virtualenv
Installing in a Custom Location
Installing in the Default Location
Installing in Virtualenv
Running Carbon Within Virtualenv
Running Graphite-web Within Virtualenv
3
nginx + gunicorn
Configure nginx
Install Gunicorn
Install nginx
8
Other Global Menu Options
Changing Default Graph Parameters
Changing Graph Sizes
Deleting a Dashboard
Editing, Importing and Exporting via JSON
Login/logout
New Dashboard
Removing All Graphs
Sharing a Dashboard
4
Overview
About the project
Overview
The architecture in a nutshell