Table of Contents

Administering Carbon
- Administering Carbon
- Starting Carbon
Administering The Webapp
- Administering The Webapp
- nginx + gunicorn
Alternative storage finders
- Advanced finders
- Alternative storage finders
- Built-in finders
- Custom finders
- Installing custom finders
Apache + mod_wsgi
- Running the webapp with mod_wsgi as URL-prefixed application (Apache)
Authentication Configuration
- LDAP
- Other Authentications
Client APIs
- Client APIs
- Cubism.js
- Graphitejs
- Scales
- Structured Metrics
- txCarbonClient
Configuring Carbon
- aggregation-rules.conf
- carbon.conf
- Configuring Carbon
- relay-rules.conf
- rewrite-rules.conf
- storage-aggregation.conf
- storage-schemas.conf
- whitelist and blacklist
Configuring The Webapp
- Apache + mod_wsgi
- Configuring The Webapp
- nginx + gunicorn
- Nginx + uWSGI
Creating or Modifying a Dashboard
- Adding a Graph
- Deleting a Graph
- Importing a Graph
- Multiple Metrics - Combining Graphs
- Re-ordering Graphs
- Saving the Dashboard
Customizing Graphs
- Customizing a Single Metric Element
- Customizing the Whole Graph
- Other Operations on the Graph
- Paths and Wildcards
Data Display Formats
- format
- rawData
Database Storage
- HTTP(S) TagDB
- Local Database TagDB
- Redis TagDB
Default Installation Layout
- Carbon and Graphite-web
- Whisper
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?
Feeding In Your Data
- Existing tools and APIs
- Feeding In Your Data
- The pickle protocol
- The plaintext protocol
- Using AMQP
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()
Getting Started with the Dashboard Interface
- Completer or browser tree?
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
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
Graphing Metrics
- from / until
- target
- template
Graphite Events
- Adding Events
- Database Storage
- Graphite Events
- Managing Events in the Admin UI
- Querying Events
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
Graphite Terminology
- Graphite Terminology
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
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
Installing From Source
- Installing Carbon in a Custom Location
- Installing From Source
- Installing Graphite-web in a Custom Location
- Installing in the Default Location
Installing From Synthesize
- Installing From Synthesize
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
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
nginx + gunicorn
- Configure nginx
- Install Gunicorn
- Install nginx
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
Overview
- About the project
- Overview
- The architecture in a nutshell
- What Graphite is and is not
Running Graphite-web Within Virtualenv
- Apache mod_wsgi
- Gunicorn
- uWSGI
The Carbon Daemons
- carbon-aggregator-cache.py
- carbon-aggregator.py
- carbon-cache.py
- carbon-relay.py
- The Carbon Daemons
The Ceres Database
- Database Format
- Retrieval Behavior
- Rollup Aggregation
- Slices: Precision and Fragmentation
- Storage Overview
- The Ceres Database
The Dashboard User Interface
- Creating or Modifying a Dashboard
- Customizing Graphs
- Getting Started with the Dashboard Interface
- Other Global Menu Options
- The Dashboard User Interface
- Viewing a Dashboard
The Render URL API
- Data Display Formats
- Graph Parameters
- Graphing Metrics
- The Render URL API
The Whisper Database
- Archives: Retention and Precision
- Data Points
- Database Format
- Differences Between Whisper and RRD
- Disk Space Efficiency
- Multi-Archive Storage and Retrieval Behavior
- Performance
- Rollup Aggregation
- The Whisper Database
Tools That Work With Graphite
- Collection
- Forwarding
- Monitoring
- Other
- Storage Backend Alternates
- Tools That Work With Graphite
- Visualization
Viewing a Dashboard
- Manual and Auto Refresh
- Opening a Dashboard
- Setting the Time Range
Webapp Database Setup
- Webapp Database Setup
Working on Graphite-web
- Running the tests
- Setting up a development environment
- Working on Graphite-web
- Writing tests

Graphite Documentation

Indices and tables

© 2008–2012 Chris Davis
© 2011–2016 The Graphite Project
Licensed under the Apache License, Version 2.0.
https://graphite.readthedocs.io/en/latest/