Skip to content

Latest commit

 

History

History
255 lines (228 loc) · 7.34 KB

install.md

File metadata and controls

255 lines (228 loc) · 7.34 KB
Raw

Installation guide

ClickHouse

  • Install ClickHouse.

  • Create rollup config /etc/clickhouse-server/conf.d/graphite_rollup.xml. Pay attention to graphite_rollup tag name. The name is used below.

<yandex>
<graphite_rollup>
    <path_column_name>metric</path_column_name>
    <time_column_name>timestamp</time_column_name>
    <value_column_name>value</value_column_name>
    <version_column_name>updated</version_column_name>
	<pattern>
		<regexp>^five_sec</regexp>
		<function>any</function>
		<retention>
			<age>0</age>
			<precision>5</precision>
		</retention>
		<retention>
			<age>2592000</age>
			<precision>60</precision>
		</retention>
		<retention>
			<age>31104000</age>
			<precision>600</precision>
		</retention>
	</pattern>

	<pattern>
		<regexp>^one_min</regexp>
		<function>any</function>
		<retention>
			<age>0</age>
			<precision>60</precision>
		</retention>
		<retention>
			<age>2592000</age>
			<precision>300</precision>
		</retention>
		<retention>
			<age>31104000</age>
			<precision>1800</precision>
		</retention>
	</pattern>

	<pattern>
		<regexp>^five_min</regexp>
		<function>any</function>
		<retention>
			<age>0</age>
			<precision>300</precision>
		</retention>
		<retention>
			<age>2592000</age>
			<precision>600</precision>
		</retention>
		<retention>
			<age>31104000</age>
			<precision>1800</precision>
		</retention>
	</pattern>

	<pattern>
		<regexp>^one_sec</regexp>
		<function>any</function>
		<retention>
			<age>0</age>
			<precision>1</precision>
		</retention>
		<retention>
			<age>2592000</age>
			<precision>60</precision>
		</retention>
		<retention>
			<age>31104000</age>
			<precision>300</precision>
		</retention>
	</pattern>

	<pattern>
		<regexp>^one_hour</regexp>
		<function>any</function>
		<retention>
			<age>0</age>
			<precision>3600</precision>
		</retention>
		<retention>
			<age>31104000</age>
			<precision>86400</precision>
		</retention>
	</pattern>

	<pattern>
		<regexp>^ten_min</regexp>
		<function>any</function>
		<retention>
			<age>0</age>
			<precision>600</precision>
		</retention>
		<retention>
			<age>31104000</age>
			<precision>3600</precision>
		</retention>
	</pattern>

	<pattern>
		<regexp>^one_day</regexp>
		<function>any</function>
		<retention>
			<age>0</age>
			<precision>86400</precision>
		</retention>
	</pattern>

	<pattern>
		<regexp>^half_hour</regexp>
		<function>any</function>
		<retention>
			<age>0</age>
			<precision>1800</precision>
		</retention>
		<retention>
			<age>31104000</age>
			<precision>3600</precision>
		</retention>
	</pattern>

	<default>
		<function>any</function>
		<retention>
			<age>0</age>
			<precision>60</precision>
		</retention>
		<retention>
			<age>2592000</age>
			<precision>300</precision>
		</retention>
		<retention>
			<age>31104000</age>
			<precision>1800</precision>
		</retention>
	</default>
</graphite_rollup>
</yandex>
  • Create tables
CREATE DATABASE graphite;

CREATE TABLE graphite.metrics ( date Date DEFAULT toDate(0),  name String,  level UInt16,  parent String,  updated DateTime DEFAULT now(),  status Enum8('SIMPLE' = 0, 'BAN' = 1, 'APPROVED' = 2, 'HIDDEN' = 3, 'AUTO_HIDDEN' = 4)) ENGINE = ReplacingMergeTree(date, (parent, name), 1024, updated);

CREATE TABLE graphite.data ( metric String,  value Float64,  timestamp UInt32,  date Date,  updated UInt32) ENGINE = GraphiteMergeTree(date, (metric, timestamp), 8192, 'graphite_rollup');

Notice: If you don't want ClickHouse to rollup data, you can use ReplacingMergeTree instead of GraphiteMergeTree.

CREATE TABLE graphite.data ( metric String,  value Float64,  timestamp UInt32,  date Date,  updated UInt32) ENGINE = ReplacingMergeTree(date, (metric, timestamp), 8192, updated)

But you still need to describe the rules for the rotation, so that Graphouse knows its metrics retention.

Graphouse

  • Add ClickHouse debian repo. See doc.
  • Install JDK8.
  • Install Graphouse sudo apt-get install graphouse
  • Set graphouse.clickhouse.retention-config property in graphouse config /etc/graphouse/graphouse.properties. You can skip this step, then default config will be used.
  • Start graphouse sudo /etc/init.d/graphouse start

If you have any problems check graphouse log dir for details /var/log/graphouse. See Configuration for more details.

Notice: Config name for graphouse.clickhouse.retention-config is not a file path, that you have copied /etc/clickhouse-server/conf.d/graphite_rollup.xml! You should use one of names from ClickHouse system.graphite_retentions table that you may retrieve with query:

SELECT
    priority,
    is_default,
    config_name,
    regexp,
    function,
    groupArray(age) AS ages,
    groupArray(precision) AS precisions
FROM
(
    SELECT *
    FROM system.graphite_retentions
    ORDER BY
        priority ASC,
        age ASC
)
GROUP BY
    config_name,
    regexp,
    function,
    priority,
    is_default
ORDER BY priority ASC

Basically if you have used XML config from an example above, this name will be graphite_rollup, that defined inside <yandex></yandex> child elements:

<yandex>
  <graphite_rollup>
    ...
  </graphite_rollup>
</yandex>

Graphite-web

  • Install graphite-web, if you don't have it already. You don't need carbon or whisper, Graphouse and ClickHouse completely replace them.
  • Add graphouse plugin /opt/graphouse/bin/graphouse.py to your graphite webapp root dir. For example, if you dir is /opt/graphite/webapp/graphite/ use command below
sudo ln -fs /opt/graphouse/bin/graphouse.py /opt/graphite/webapp/graphite/graphouse.py
STORAGE_FINDERS = (
    'graphite.graphouse.GraphouseFinder',
)
  • Restart graphite-web

Graphite-api

Graphite-API is an alternative to Graphite-web, without any built-in dashboard. Its role is solely to fetch metrics from a time-series database (in our case - Graphouse) and rendering graphs or JSON data out of these time series. It is meant to be consumed by any of the numerous Graphite dashboard applications.

  • Install graphite-api, if you don't have it already. You don't need carbon or whisper, Graphouse and ClickHouse completely replace them.
  • Add graphouse plugin /opt/graphouse/bin/graphouse_api.py to your graphite-api finders dir. For example, if you dir is /usr/local/lib/python3.6/site-packages/graphite_api/finders use command below
sudo ln -fs /opt/graphouse/bin/graphouse_api.py /usr/local/lib/python3.6/site-packages/graphite_api/finders/graphouse_api.py
finders:
  - graphite_api.finders.graphouse_api.GraphouseFinder 
graphouse:
  url: http://localhost:2005

(do not forget to change graphouse URL if needed)

  • Restart graphite-api