Skip to content

Add collector component #930

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 10 commits into from
Mar 28, 2022
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 3 additions & 5 deletions docs/agent/collectors/go.d.plugin/modules/activemq.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,10 @@
---
title: "ActiveMQ monitoring with Netdata"
description: "Monitor the health and performance of ActiveMQ message brokers with zero configuration, per-second metric granularity, and interactive visualizations."
title: 'ActiveMQ monitoring with Netdata'
description: 'Monitor the health and performance of ActiveMQ message brokers with zero configuration, per-second metric granularity, and interactive visualizations.'
custom_edit_url: https://github.com/netdata/go.d.plugin/edit/master/modules/activemq/README.md
sidebar_label: "ActiveMQ"
sidebar_label: 'ActiveMQ'
---



[`ActiveMQ`](https://activemq.apache.org/) is an open source message broker written in Java together with a full Java
Message Service client.

Expand Down
114 changes: 114 additions & 0 deletions src/components/Collectors/_collector-components.jsx
Original file line number Diff line number Diff line change
@@ -0,0 +1,114 @@
{
/* This piece of code generates the configuration section of a collector
Usage: This file needs to be imported in an MDX file like this:

import CollectorConfiguration from '@site/src/components/Collectors/_collector-config.jsx';

<CollectorConfiguration
configURL=""
moduleName=""
/>

configURL: Assign the Github URL of the collector's configuration file
moduleName: Assign the name of the collector in the following schema: PLUGIN/COLLECTOR.conf */
}

import React from 'react';
import CodeBlock from '@theme/CodeBlock';

export function CollectorConfiguration({ configURL, moduleName }) {
return (
<>
<p>
To edit the <code>{moduleName} </code> configuration file:
</p>

<ol>
<li>
Navigate to the{' '}
<a href="/docs/configure/nodes#the-netdata-config-directory">
Netdata config directory
</a>
.<CodeBlock className="bash">cd /etc/netdata</CodeBlock>
</li>
<li>
Use the{' '}
<a href="/docs/configure/nodes#use-edit-config-to-edit-configuration-files">
<code>edit-config</code>
</a>{' '}
script to edit <code>{moduleName}</code>.
<CodeBlock className="bash">
sudo ./edit-config {moduleName}
</CodeBlock>
</li>
<li>
Enable changes to the collector by setting <code>enabled: yes</code>.
</li>
<li>
Save the changes and restart the Agent with{' '}
<code>sudo systemctl restart netdata</code> or the{' '}
<a href="/docs/configure/start-stop-restart">appropriate method</a>{' '}
for your system.
</li>
</ol>

<p>
For all available options, please see the module{' '}
<a href={configURL}>configuration file</a>.
</p>
</>
);
}

{
/* This piece of code generates the configuration section of a collector
Usage: This file needs to be imported in an MDX file like this:

import CollectorDebug from '@site/src/components/Collectors/_collector-debugging.jsx';

<CollectorDebug
pluginName=""
collectorName=""
/>

pluginName: Assign the plugin name, for example go.d.plugin
collectorName: Assign the name of the collector, for example activemq
*/
}

export function CollectorDebug({ pluginName, collectorName }) {
return (
<>
<p>
To troubleshoot issues with the <code>{collectorName}</code> collector,
run the <code>{pluginName}</code> with the debug option enabled.
</p>

<ol>
<li>
Navigate to your plugins directory, usually at
<code>/usr/libexec/netdata/plugins.d/</code>. If that's not the case
on your system, open <code>netdata.conf</code> and look for the
setting <code>plugins directory</code>.{' '}
</li>
<li>
In the plugins directory, switch to the <code>netdata</code> user.
<CodeBlock className="bash">
cd /usr/libexec/netdata/plugins.d/ sudo -u netdata -s
</CodeBlock>{' '}
</li>

<li>
Run the <code>{pluginName}</code> in debug mode to identify issues:
<CodeBlock className="bash">
./{pluginName} -d -m {collectorName}
</CodeBlock>
<p>
The output should give you clues as to why the collector isn't
working.
</p>
</li>
</ol>
</>
);
}