Difference between revisions of "Netdata"

[quality revision] [unchecked revision]
m
 

1 Article Purpose[edit]

This article provides the basic information needed to start using the Linux® monitoring tool: netdata[1].

2 Introduction[edit]

The following table provides a brief description of the tool, as well as its availability depending on the software packages:

Yes: this tool is either present (ready to use or to be activated), or can be integrated and activated on the software package.

No: this tool is not present and cannot be integrated, or it is present but cannot be activated on the software package.

Under construction.png Coming soon
Tool STM32MPU Embedded Software distribution STM32MPU Embedded Software distribution for Android™
Name Category Purpose Starter Package Developer Package Distribution Package Starter Package Developer Package Distribution Package
netdata Monitoring tools netdata[1] is a system for distributed real-time performance and health monitoring. It provides unparalleled insights, in real-time, of everything happening on the system it runs (including applications such as web and database servers), using modern interactive web dashboards. Yes Yes Yes No No No

3 Installing the trace and debug tool on your target board[edit]

3.1 Using the STM32MPU Embedded Software distribution[edit]

netdata is installed by default and ready to be used with all STM32MPU Embedded Software Packages.

Board $> which netdata
/usr/sbin/netdata

It is integrated in weston image distribution through meta-st package: meta-st/meta-st-openstlinux/recipes-st/packagegroups/packagegroup-framework-tools.bb.

RDEPENDS_packagegroup-framework-tools-ui = "\
   ${@bb.utils.contains('DISTRO_FEATURES', 'x11', 'xvinfo', , d)}    \
   ${@bb.utils.contains('DISTRO_FEATURES', 'gplv3', 'glmark2', , d)} \
   ${@bb.utils.contains('DISTRO_FEATURES', 'gplv3', 'netdata', , d)} \
   ${@bb.utils.contains('DISTRO_FEATURES', 'gplv3', 'lmsensors-libsensors', , d)} \
   "
3.2 Using the STM32MPU Embedded Software distribution for Android™[edit]
Under construction.png Coming soon

4 Getting started[edit]

netdata provides all monitoring information on a web page accessible at the IP address of the board.

It proposes a default web page, on port 19999. It is also possible to create a custom page.

4.1 netdata service[edit]

netdata is managed as a service. In OpenSTLinux distribution, it can be found under meta-st/meta-st-openstlinux/recipes-webadmin/netdata/netdata/netdata.service.

The following command allows to verify if the service is active and running on the target board:

Board $> systemctl | grep netdata
  netdata.service                           loaded active running  Netdata, Real-time performance monitoring

In case it is not running, the service can be started using the following command:

Board $> systemctl start netdata

It is recommended to stop the service when it is not needed any longer:

 
Board $> systemctl stop netdata

4.2 Generic netdata web page[edit]

On host PC browser, the generic netdata web page is found at address:

http://<ip_of_board>:19999

Netdata screenshot main.png

4.3 Customized netdata web page[edit]

A customized web page is proposed in OpenSTLinux environment to monitor some specific indicators: STM32MP1 Dashboard

  • Starter and Developer Packages
- directly accessible on the target under: /usr/share/netdata/web/stm32.html
  • Distribution Package
- available under recipes-webadmin directory in file: meta-st/meta-st-openstlinux/recipes-webadmin/netdata/netdata/stm32.html

On host PC browser, it is available at address:

http://<ip_of_board>:19999/stm32.html

Netdata screenshot stm32.png

5 References[edit]


  • Useful external links
Document link Document Type Description
netdata source and documentation page Standard GitHub link reference



<noinclude>

{{ArticleBasedOnModel|[[Trace and debug tools article model]]}}
{{ArticleMainWriter|Jean-PhilippeR}}
{{ ArticleApprovedVersion | Jean-PhilippeR | Jean-ChristopheT, ChristopheP  | No previous approved version  | BrunoB - 08Oct'18 - 9038 | 10Oct'18 }}

[[Category:Linux monitoring tools]]</noinclude>

== Article Purpose ==
This article provides the basic information needed to start using the Linux<sup>&reg;</sup> monitoring tool: '''netdata'''<ref name=netdatadotio/>.

== Introduction ==
{{:Trace_and_debug_tools_assignment_table_template}}<onlyinclude>

 | [[Netdata|netdata]]
 | [[:Category:Monitoring tools|Monitoring tools]]
 | style="text-align:left;" | '''netdata'''<ref name=netdatadotio>https://my-netdata.io</ref> is a system for distributed real-time performance and health monitoring. It provides unparalleled insights, in real-time, of everything happening on the system it runs (including applications such as web and database servers), using modern interactive web dashboards.
 | {{Y}} || {{Y}} || {{Y}}
 | colspan="3" | {{UnderConstruction}}{{N}} || {{N}} || {{N}}|-</onlyinclude>

 |}

== Installing the trace and debug tool on your target board ==
=== Using the STM32MPU Embedded Software distribution ===
'''netdata''' is installed by default and ready to be used with all STM32MPU Embedded Software Packages.
 {{Board$}} which netdata
 /usr/sbin/netdata

It is integrated in weston image distribution through meta-st package: ''meta-st/meta-st-openstlinux/recipes-st/packagegroups/packagegroup-framework-tools.bb''.
 RDEPENDS_packagegroup-framework-tools-ui = "\
    ${@bb.utils.contains('DISTRO_FEATURES', 'x11', 'xvinfo', '', d)}    \
    ${@bb.utils.contains('DISTRO_FEATURES', 'gplv3', 'glmark2', '', d)} \
    {{green|'''${@bb.utils.contains('DISTRO_FEATURES', 'gplv3', 'netdata', '', d)}'''}} \
    ${@bb.utils.contains('DISTRO_FEATURES', 'gplv3', 'lmsensors-libsensors', '', d)} \
    "

=== Using the STM32MPU Embedded Software distribution for Android&trade; ===
{{underConstruction}}

==  Getting started ==
'''netdata''' provides all monitoring information on a web page accessible at the IP address of the board.  

It proposes a default web page, on port 19999. It is also possible to create a custom page.

=== netdata service ===
'''netdata''' is managed as a service. In OpenSTLinux distribution, it can be found under ''meta-st/meta-st-openstlinux/recipes-webadmin/netdata/netdata/netdata.service''.

The following command allows to verify if the service is active and running on the target board:
 {{Board$}} systemctl | grep netdata
   netdata.service                           loaded {{green|'''active running'''}}  Netdata, Real-time performance monitoring

In case it is not running, the service can be started using the following command:
 {{Board$}} systemctl start netdata

It is recommended to stop the service when it is not needed any longer:
  {{Board$}} systemctl stop netdata

=== Generic netdata web page ===
On host PC browser, the generic netdata web page is found at address:<nowiki>http</nowiki>://{{orange|<''ip_of_board''>}}:19999

[[File:netdata_screenshot_main.png|1000px|link=]]

=== Customized netdata web page ===
A customized web page is proposed in OpenSTLinux environment to monitor some specific indicators: '''STM32MP1 Dashboard'''

*Starter and Developer Packages
:- directly accessible on the target under: ''/usr/share/netdata/web/stm32.html''

*Distribution Package
:- available under recipes-webadmin directory in file: ''meta-st/meta-st-openstlinux/recipes-webadmin/netdata/netdata/stm32.html''

On host PC browser, it is available at address:<nowiki>http</nowiki>://{{orange|<''ip_of_board''>}}:19999/stm32.html

[[File:netdata_screenshot_stm32.png|1000px|link=]]

== References ==<references />


* Useful external links
{|
! scope=col | Document link
! scope=col | Document Type
! scope=col | Description
|-
| [https://github.com/firehol/netdata netdata source and documentation page]
| Standard
| GitHub link reference
|}


{{ ArticleBasedOnModel | Trace and debug tools article model}}
{{ PublicationRequestId | 9038 | 08Oct'18 }}

[[Category:Linux monitoring tools]]
Line 1: Line 1:
<noinclude>
 
{{ArticleBasedOnModel|[[Trace and debug tools article model]]}}
 
{{ArticleMainWriter|Jean-PhilippeR}}
 
{{ ArticleApprovedVersion | Jean-PhilippeR | Jean-ChristopheT, ChristopheP  | No previous approved version  | BrunoB - 08Oct'18 - 9038 | 10Oct'18 }}
 
 
[[Category:Linux monitoring tools]]
 
</noinclude>
 
 
 
== Article Purpose ==
 
== Article Purpose ==
 
This article provides the basic information needed to start using the Linux<sup>&reg;</sup> monitoring tool: '''netdata'''<ref name=netdatadotio/>.
 
This article provides the basic information needed to start using the Linux<sup>&reg;</sup> monitoring tool: '''netdata'''<ref name=netdatadotio/>.
Line 17: Line 9:
 
  | style="text-align:left;" | '''netdata'''<ref name=netdatadotio>https://my-netdata.io</ref> is a system for distributed real-time performance and health monitoring. It provides unparalleled insights, in real-time, of everything happening on the system it runs (including applications such as web and database servers), using modern interactive web dashboards.
 
  | style="text-align:left;" | '''netdata'''<ref name=netdatadotio>https://my-netdata.io</ref> is a system for distributed real-time performance and health monitoring. It provides unparalleled insights, in real-time, of everything happening on the system it runs (including applications such as web and database servers), using modern interactive web dashboards.
 
  | {{Y}} || {{Y}} || {{Y}}
 
  | {{Y}} || {{Y}} || {{Y}}
  | colspan="3" | {{UnderConstruction}}
+
  | {{N}} || {{N}} || {{N}}
 
  |-
 
  |-
 
</onlyinclude>
 
</onlyinclude>
Line 35: Line 27:
 
     ${@bb.utils.contains('DISTRO_FEATURES', 'gplv3', 'lmsensors-libsensors', '', d)} \
 
     ${@bb.utils.contains('DISTRO_FEATURES', 'gplv3', 'lmsensors-libsensors', '', d)} \
 
     "
 
     "
 
=== Using the STM32MPU Embedded Software distribution for Android&trade; ===
 
{{underConstruction}}
 
   
 
== Getting started ==
 
== Getting started ==
Line 91: Line 80:
 
| GitHub link reference
 
| GitHub link reference
 
|}
 
|}
  +
  +
{{ ArticleBasedOnModel | Trace and debug tools article model}}
  +
{{ PublicationRequestId | 9038 | 08Oct'18 }}
  +
  +
[[Category:Linux monitoring tools]]

Attachments

Discussions