customize.mdx 4.7 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899
  1. ---
  2. title: "Customize the standard dashboard"
  3. description: >-
  4. "Netdata's preconfigured dashboard offers many customization options, such as choosing when
  5. charts are updated, your preferred theme, and custom text to document processes, and more."
  6. type: "how-to"
  7. custom_edit_url: "https://github.com/netdata/netdata/blob/master/docs/dashboard/customize.mdx"
  8. sidebar_label: "Customize the standard dashboard"
  9. learn_status: "Published"
  10. learn_topic_type: "Tasks"
  11. learn_rel_path: "Operations"
  12. ---
  13. # Customize the standard dashboard
  14. While the [Netdata dashboard](https://github.com/netdata/netdata/blob/master/docs/dashboard/how-dashboard-works.mdx) comes preconfigured with hundreds of charts and
  15. thousands of metrics, you may want to alter your experience based on a particular use case or preferences.
  16. ## Dashboard settings
  17. To change dashboard settings, click the on the **settings** icon ![Import
  18. icon](https://raw.githubusercontent.com/netdata/netdata-ui/98e31799c1ec0983f433537ff16d2ac2b0d994aa/src/components/icon/assets/gear.svg)
  19. in the top panel.
  20. These settings only affect how the dashboard behaves in your browser. They take effect immediately and are permanently
  21. saved to browser local storage (except the refresh on focus / always option). Some settings are applied immediately, and
  22. others are only reflected after the dashboard is refreshed, which happens automatically.
  23. Here are a few popular settings:
  24. ### Change chart legend position
  25. Find this setting under the **Visual** tab. By default, Netdata places the [legend of dimensions](https://github.com/netdata/netdata/blob/master/docs/dashboard/dimensions-contexts-families.mdx#dimension) _below_ charts.
  26. Click this toggle to move the legend to the _right_ of charts.
  27. ### Change theme
  28. Find this setting under the **Visual** tab. Choose between Dark (the default) and White.
  29. ## Customize the standard dashboard info
  30. Netdata stores information about individual charts in the `dashboard_info.js` file. This file includes section and
  31. subsection headings, descriptions, colors, titles, tooltips, and other information for Netdata to render on the
  32. dashboard.
  33. One common use case for customizing the standard dashboard is adding internal "documentation" a section or specific
  34. chart that can then be read by anyone with access to that dashboard.
  35. For example, here is how `dashboard_info.js` defines the **System Overview** section.
  36. ```javascript
  37. netdataDashboard.menu = {
  38. 'system': {
  39. title: 'System Overview',
  40. icon: '<i class="fas fa-bookmark"></i>',
  41. info: 'Overview of the key system metrics.'
  42. },
  43. ```
  44. If you want to customize this information, use the example `dashboard_info_custom_example.js` as a starting point.
  45. First, navigate to the web server's directory. If you're on a Linux system, this should be at `/usr/share/netdata/web/`.
  46. Copy the example file, then ensure that its permissions match the rest of the web server, which is `netdata:netdata` by
  47. default.
  48. ```bash
  49. cd /usr/share/netdata/web/
  50. sudo cp dashboard_info_custom_example.js your_dashboard_info_file.js
  51. sudo chown netdata:netdata your_dashboard_info_file.js
  52. ```
  53. Edit the file with customizations to the `title`, `icon`, and `info` fields. Replace the string after `fas fa-` with any
  54. icon from [Font Awesome](https://fontawesome.com/cheatsheet) to customize the icons that appear throughout the
  55. dashboard.
  56. Save the file, then navigate to your [Netdata config directory](https://github.com/netdata/netdata/blob/master/docs/configure/nodes.md) to edit `netdata.conf`. Add
  57. the following line to the `[web]` section to tell Netdata where to find your custom configuration.
  58. ```conf
  59. [web]
  60. custom dashboard_info.js = your_dashboard_info_file.js
  61. ```
  62. Reload your browser tab to see your custom configuration.
  63. ## What's next?
  64. If you're keen on continuing to customize your Netdata experience, check out our docs on [building new custom
  65. dashboards](https://github.com/netdata/netdata/blob/master/web/gui/custom/README.md) with HTML, CSS, and JavaScript.
  66. ### Further reading & related information
  67. - Dashboard
  68. - [How the dashboard works](https://github.com/netdata/netdata/blob/master/docs/dashboard/how-dashboard-works.mdx)
  69. - [Interact with charts](https://github.com/netdata/netdata/blob/master/docs/dashboard/interact-charts.mdx)
  70. - [Chart dimensions, contexts, and families](https://github.com/netdata/netdata/blob/master/docs/dashboard/dimensions-contexts-families.mdx)
  71. - [Select timeframes to visualize](https://github.com/netdata/netdata/blob/master/docs/dashboard/visualization-date-and-time-controls.mdx)
  72. - [Import, export, and print a snapshot](https://github.com/netdata/netdata/blob/master/docs/dashboard/import-export-print-snapshot.mdx)
  73. - **[Customize the standard dashboard](https://github.com/netdata/netdata/blob/master/docs/dashboard/customize.mdx)**