Skip to content

Commit

Permalink
Merge pull request #131 from sentrysoftware/feature/issue-128-add-def…
Browse files Browse the repository at this point in the history
…ault-connectors-in-connectorsmd

Issue #128: Add default `variables` in connector.md
  • Loading branch information
NassimBtk authored Oct 22, 2024
2 parents e8cc817 + 2179aa0 commit 29c9d22
Showing 1 changed file with 16 additions and 9 deletions.
25 changes: 16 additions & 9 deletions src/site/markdown/develop/connector.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,19 +30,21 @@ connector:
projectVersion: # <string> | default: {esc.d}${project.version}
information: # <string>
detection: # <object>
variables: # <object>
```
### Properties
| Property | Description |
| --------------------- | ------------------------ |
| `displayName` | Name of the connector, which can be displayed in the console or reported in the metric’s attribute.(`connector.status{name="Dell OpenManage (WMI)"}`)<br />This preferably refers to the underlying instrumentation layer (e.g.: Dell OpenManage (WMI)).<br />If several connectors are required to cover different aspects of a platform (one connector for the CPU, memory, another for the disks, and a last one for the network cards, for example), the name will specify it with a dash separator.<br /><br />The typical display name therefore looks like:<br />`<Instrumentation Layer> [ - Subcomponent ] [ - OS ] [ (protocol) ]`. |
| `information` | Describes what the connector monitors and how.<br /><br /> This ends up in the documentation of the Hardware Connector Library as the description of the connector.<br /> Do not hesitate to provide details about the specific requirements for the connector to work properly. |
| `platforms` | Typical targeted system.<br /> Examples: "`HP ProLiant`" or "`Any system with SNMP`"<br /> This property is leveraged to build the Supported Platforms in the documentation.<br /> The platform name must be short and simple enough to group several connectors targeting the same type of systems.<br /> Several platforms can be specified in a comma-separated list.<br /> Connectors that monitor components that may be present in large number of platforms (e.g.: the <br /> connector which monitors network cards in all Windows systems) must specify: `Any system with [xxx]`. |
| `reliesOn` | Name of the instrumentation layer this connector leverages. This can also be considered as the <br /> technical prerequisites for this connector work, but it can only mention one instrumentation layer. <br /><br />This also ends up in the documentation and in the [Supported Platforms](../platform-requirements.html) and it is important that all<br /> connectors have a consistent wording for this property. |
| `projectVersion` | The current version of the connector library project. |
| `version` | The current version of the connector. |
| `detection` | Defines all the information required to perform connector’s detection. See specification in [Detection](detection.md). |
| Property | Description |
| --------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `displayName` | Name of the connector, which can be displayed in the console or reported in the metric’s attribute.(`connector.status{name="Dell OpenManage (WMI)"}`)<br />This preferably refers to the underlying instrumentation layer (e.g.: Dell OpenManage (WMI)).<br />If several connectors are required to cover different aspects of a platform (one connector for the CPU, memory, another for the disks, and a last one for the network cards, for example), the name will specify it with a dash separator.<br /><br />The typical display name therefore looks like:<br />`<Instrumentation Layer> [ - Subcomponent ] [ - OS ] [ (protocol) ]`. |
| `information` | Describes what the connector monitors and how.<br /><br /> This ends up in the documentation of the Hardware Connector Library as the description of the connector.<br /> Do not hesitate to provide details about the specific requirements for the connector to work properly. |
| `platforms` | Typical targeted system.<br /> Examples: "`HP ProLiant`" or "`Any system with SNMP`"<br /> This property is leveraged to build the Supported Platforms in the documentation.<br /> The platform name must be short and simple enough to group several connectors targeting the same type of systems.<br /> Several platforms can be specified in a comma-separated list.<br /> Connectors that monitor components that may be present in large number of platforms (e.g.: the <br /> connector which monitors network cards in all Windows systems) must specify: `Any system with [xxx]`. |
| `reliesOn` | Name of the instrumentation layer this connector leverages. This can also be considered as the <br /> technical prerequisites for this connector work, but it can only mention one instrumentation layer. <br /><br />This also ends up in the documentation and in the [Supported Platforms](../platform-requirements.html) and it is important that all<br /> connectors have a consistent wording for this property. |
| `projectVersion` | The current version of the connector library project. |
| `version` | The current version of the connector. |
| `detection` | Defines all the information required to perform connector’s detection. See specification in [Detection](detection.md). |
| `variables` | The name, description & default value of each connector default variable. If the user does not specify values for these variables, default variables are used instead. |

## Embedded Files

Expand Down Expand Up @@ -175,6 +177,11 @@ connector:
expectedResult: # <string>
forceSerialization: # <boolean>
variables:
<variableName>:
description: # <string>
defaultValue: # <string>
sudoCommands: # <string-array>
extends: # <string-array>
Expand Down

0 comments on commit 29c9d22

Please sign in to comment.