45273c1ff · cryptotaxi247/netdata-1

@@ -1,143 +0,0 @@

1 -<!--

2 -title: "Health quickstart"

3 -custom_edit_url: https://github.com/netdata/netdata/edit/master/health/QUICKSTART.md

4 --->

5 -

6 -# Health quickstart

7 -

8 -In this quickstart guide, you'll learn the basics of editing health configuration files. With this knowledge, you

9 -will be able to customize how and when Netdata triggers alarms based on the health and performance of your system or

10 -infrastructure.

11 -

12 -To learn about more advanced health configurations, visit the [health reference guide](/health/REFERENCE.md).

13 -

14 -## Edit health configuration files

15 -

16 -You should [use `edit-config`](/docs/configure/nodes.md) to edit Netdata's health configuration files. `edit-config`

17 -will open your system's default terminal editor for you to make your changes. Once you've saved and closed the editor,

18 -`edit-config` will copy your edited file into `/etc/netdata/health.d/`, which will override the stock file in

19 -`/usr/lib/netdata/conf.d/health.d/` and ensure your customizations are persistent between updates.

20 -

21 -For example, to edit the `cpu.conf` health configuration file, you would run:

22 -

23 -```bash

24 -cd /etc/netdata/ # Replace with your Netdata configuration directory, if not /etc/netdata/

25 -./edit-config health.d/cpu.conf

26 -```

27 -

28 -Each health configuration file contains one or more health entities, which always begin with an `alarm:` or `template:`

29 -line. You can edit these entities based on your needs. To make any changes live, be sure to [reload your health

30 -configuration](#reload-health-configuration).

31 -

32 -## Reference Netdata's stock health configuration files

33 -

34 -While you should always [use `edit-config`](#edit-health-configuration-files), you might also want to view the stock

35 -health configuration files Netdata ships with. Stock files can be useful as reference material, or to determine which

36 -file you should edit with `edit-config`.

37 -

38 -By default, Netdata will put health configuration files in `/usr/lib/netdata/conf.d/health.d`. However, you can

39 -double-check the location of these files by navigating to `http://NODE:19999/netdata.conf`, replacing `NODE` with the IP

40 -address or hostname for your Agent dashboard, looking for the `stock health configuration directory` option. The value

41 -here will show the correct path for your installation.

42 -

43 -```conf

44 -[directories]

45 - ...

46 - # stock health config = /usr/lib/netdata/conf.d/health.d

47 -```

48 -

49 -Navigate to the health configuration directory to see all the available files and open them for reading.

50 -

51 -```bash

52 -cd /usr/lib/netdata/conf.d/health.d/

53 -ls

54 -adaptec_raid.conf entropy.conf memory.conf squid.conf

55 -am2320.conf mongodb.conf

56 -apache.conf mysql.conf swap.conf

57 -...

58 -```

59 -

60 -> ⚠️ If you edit configuration files in your stock health configuration directory, Netdata will overwrite them during

61 -> any updates. Please use `edit-config` as described in the [section above](#edit-health-configuration-files).

62 -

63 -## Write a new health entity

64 -

65 -While tuning existing alarms may work in some cases, you may need to write entirely new health entities based on how

66 -your systems and applications work.

67 -

68 -To write a new health entity, let's create a new file inside of the `health.d/` directory. We'll name our file

69 -`example.conf` for now.

70 -

71 -```bash

72 -./edit-config health.d/example.conf

73 -```

74 -

75 -As an example, let's build a health entity that triggers an alarm your system's RAM usage goes above 80%. Copy and paste

76 -the following into the editor:

77 -

78 -```yaml

79 - alarm: ram_usage

80 - on: system.ram

81 -lookup: average -1m percentage of used

82 - units: %

83 - every: 1m

84 - warn: $this > 80

85 - crit: $this > 90

86 - info: The percentage of RAM used by the system.

87 -```

88 -

89 -Let's look into each of the lines to see how they create a working health entity.

90 -

91 -- `alarm`: The name for your new entity. The name needs to follow these requirements:

92 - - Any alphabet letter or number.

93 - - The symbols `.` and `_`.

94 - - Cannot be `chart name`, `dimension name`, `family name`, or `chart variable names`.

95 -- `on`: Which chart the entity listens to.

96 -- `lookup`: Which metrics the alarm monitors, the duration of time to monitor, and how to process the metrics into a

97 - usable format.

98 - - `average`: Calculate the average of all the metrics collected.

99 - - `-1m`: Use metrics from 1 minute ago until now to calculate that average.

100 - - `percentage`: Clarify that we're calculating a percentage of RAM usage.

101 - - `of used`: Specify which dimension (`used`) on the `system.ram` chart you want to monitor with this entity.

102 -- `units`: Use percentages rather than absolute units.

103 -- `every`: How often to perform the `lookup` calculation to decide whether or not to trigger this alarm.

104 -- `warn`/`crit`: The value at which Netdata should trigger a warning or critical alarm.

105 -- `info`: A description of the alarm, which will appear in the dashboard and notifications.

106 -

107 -Let's put all these lines into a human-readable format.

108 -

109 -This health entity, named **ram_usage**, watches at the **system.ram** chart. It looks up the last **1 minute** of

110 -metrics from the **used** dimension and calculates the **average** of all those metrics in a **percentage** format,

111 -using a **% unit**. The entity performs this lookup **every minute**. If the average RAM usage percentage over the last

112 -1 minute is **more than 80%**, the entity triggers a warning alarm. If the usage is **more than 90%**, the entity

113 -triggers a critical alarm.

114 -

115 -Now that you've written a new health entity, you need to reload it to see it live on the dashboard.

116 -

117 -## Reload health configuration

118 -

119 -To make any changes to your health configuration live, you must reload Netdata's health monitoring system. To do that

120 -without restarting all of Netdata, run the following:

121 -

122 -```bash

123 -netdatacli reload-health

124 -```

125 -

126 -If you receive an error like `command not found`, this means that `netdatacli` is not installed in your `$PATH`. In that

127 - case, you can reload only the health component by sending a `SIGUSR2` to Netdata:

128 -

129 -```bash

130 -killall -USR2 netdata

131 -```

132 -## What's next?

133 -

134 -To learn about all of Netdata's health configuration options, view the [reference guide](/health/REFERENCE.md) and

135 -[daemon configuration](/daemon/config/README.md#health-section-options) for additional options available in the

136 -`[health]` section of `netdata.conf`.

137 -

138 -Or, get guided insights into specific health configurations with our [health guides](/health/README.md#guides).

139 -

140 -Finally, move on to Netdata's [notification system](/health/notifications/README.md) to learn more about how Netdata can

141 -let you know when the health of your systems or apps goes awry.

142 -

143 -

Delete QUICKSTART.md (#14355)