lots of make, fixed typo

open-telemetry · Feb 10, 2025 · a5b4c17 · a5b4c17
1 parent 3515845
commit a5b4c17
Show file tree

Hide file tree

Showing 30 changed files with 109 additions and 86 deletions.
diff --git a/.github/ISSUE_TEMPLATE/bug_report.yaml b/.github/ISSUE_TEMPLATE/bug_report.yaml
@@ -310,6 +310,7 @@ body:
       - receiver/webhookevent
       - receiver/windowseventlog
       - receiver/windowsperfcounters
+      - receiver/windowsservice
       - receiver/zipkin
       - receiver/zookeeper
       - scraper/zookeeperscraper

diff --git a/.github/ISSUE_TEMPLATE/feature_request.yaml b/.github/ISSUE_TEMPLATE/feature_request.yaml
@@ -304,6 +304,7 @@ body:
       - receiver/webhookevent
       - receiver/windowseventlog
       - receiver/windowsperfcounters
+      - receiver/windowsservice
       - receiver/zipkin
       - receiver/zookeeper
       - scraper/zookeeperscraper

diff --git a/.github/ISSUE_TEMPLATE/other.yaml b/.github/ISSUE_TEMPLATE/other.yaml
@@ -304,6 +304,7 @@ body:
       - receiver/webhookevent
       - receiver/windowseventlog
       - receiver/windowsperfcounters
+      - receiver/windowsservice
       - receiver/zipkin
       - receiver/zookeeper
       - scraper/zookeeperscraper

diff --git a/.github/ISSUE_TEMPLATE/unmaintained.yaml b/.github/ISSUE_TEMPLATE/unmaintained.yaml
@@ -309,6 +309,7 @@ body:
       - receiver/webhookevent
       - receiver/windowseventlog
       - receiver/windowsperfcounters
+      - receiver/windowsservice
       - receiver/zipkin
       - receiver/zookeeper
       - scraper/zookeeperscraper

diff --git a/receiver/windowsservicereciever/Makefile → receiver/windowsservicereceiver/Makefile b/receiver/windowsservicereciever/Makefile → receiver/windowsservicereceiver/Makefile
diff --git a/receiver/windowsservicereceiver/README.md b/receiver/windowsservicereceiver/README.md
@@ -0,0 +1,42 @@
+# Windows Service Receiver
+
+<!-- status autogenerated section -->
+| Status        |           |
+| ------------- |-----------|
+| Stability     | [development]: metrics   |
+| Unsupported Platforms | darwin, linux |
+| Distributions | [contrib] |
+| Issues        | [![Open issues](https://img.shields.io/github/issues-search/open-telemetry/opentelemetry-collector-contrib?query=is%3Aissue%20is%3Aopen%20label%3Areceiver%2Fwindowsservice%20&label=open&color=orange&logo=opentelemetry)](https://github.com/open-telemetry/opentelemetry-collector-contrib/issues?q=is%3Aopen+is%3Aissue+label%3Areceiver%2Fwindowsservice) [![Closed issues](https://img.shields.io/github/issues-search/open-telemetry/opentelemetry-collector-contrib?query=is%3Aissue%20is%3Aclosed%20label%3Areceiver%2Fwindowsservice%20&label=closed&color=blue&logo=opentelemetry)](https://github.com/open-telemetry/opentelemetry-collector-contrib/issues?q=is%3Aclosed+is%3Aissue+label%3Areceiver%2Fwindowsservice) |
+| [Code Owners](https://github.com/open-telemetry/opentelemetry-collector-contrib/blob/main/CONTRIBUTING.md#becoming-a-code-owner)    | [@shalper2](https://www.github.com/shalper2) |
+
+[development]: https://github.com/open-telemetry/opentelemetry-collector/blob/main/docs/component-stability.md#development
+[contrib]: https://github.com/open-telemetry/opentelemetry-collector-releases/tree/main/distributions/otelcol-contrib
+<!-- end autogenerated section -->
+
+The Windows Service Receiver is a receiver for scraping information about services running on a Windows machine.
+
+## Getting Started
+
+By default the Windows Service Receiver will attempt to identify and monitor the status of all specified services on the host machine. 
+
+An example of monitoring three services on a host:
+```yaml
+windowsservice:
+  collection_interval: <duration> # default = 1m
+  include_services:
+    - service1
+    - service2
+    - service3
+    ...
+```
+The case where you wish to monitor all services present on a host machine, except for `service3`:
+```yaml
+windowsservice:
+  collection_interval: <duration> # default = 1m
+  include_services:
+  exclude_services:
+    - service3
+    ...
+```
+
+### Notes
diff --git a/receiver/windowsservicereciever/config.go → receiver/windowsservicereceiver/config.go b/receiver/windowsservicereciever/config.go → receiver/windowsservicereceiver/config.go
diff --git a/...ver/windowsservicereciever/config_test.go → ...ver/windowsservicereceiver/config_test.go b/...ver/windowsservicereciever/config_test.go → ...ver/windowsservicereceiver/config_test.go
diff --git a/receiver/windowsservicereciever/doc.go → receiver/windowsservicereceiver/doc.go b/receiver/windowsservicereciever/doc.go → receiver/windowsservicereceiver/doc.go
@@ -3,5 +3,5 @@
 
 //go:generate mdatagen metadata.yaml
 
-// Package fooreceiver bars.
+// Package windowsservice receiver.
 package windowsservicereceiver // import "github.com/open-telemetry/opentelemetry-collector-contrib/receiver/windowsservicereceiver"
diff --git a/...r/windowsservicereciever/documentation.md → ...r/windowsservicereceiver/documentation.md b/...r/windowsservicereciever/documentation.md → ...r/windowsservicereceiver/documentation.md
diff --git a/receiver/windowsservicereciever/factory.go → receiver/windowsservicereceiver/factory.go b/receiver/windowsservicereciever/factory.go → receiver/windowsservicereceiver/factory.go
diff --git a/...er/windowsservicereciever/factory_test.go → ...er/windowsservicereceiver/factory_test.go b/...er/windowsservicereciever/factory_test.go → ...er/windowsservicereceiver/factory_test.go
diff --git a/...windowsservicereciever/factory_windows.go → ...windowsservicereceiver/factory_windows.go b/...windowsservicereciever/factory_windows.go → ...windowsservicereceiver/factory_windows.go
diff --git a/...wsservicereciever/factory_windows_test.go → ...wsservicereceiver/factory_windows_test.go b/...wsservicereciever/factory_windows_test.go → ...wsservicereceiver/factory_windows_test.go
diff --git a/...rvicereciever/generated_component_test.go → ...rvicereceiver/generated_component_test.go b/...rvicereciever/generated_component_test.go → ...rvicereceiver/generated_component_test.go
diff --git a/...servicereciever/generated_package_test.go → ...servicereceiver/generated_package_test.go b/...servicereciever/generated_package_test.go → ...servicereceiver/generated_package_test.go
diff --git a/receiver/windowsservicereciever/go.mod → receiver/windowsservicereceiver/go.mod b/receiver/windowsservicereciever/go.mod → receiver/windowsservicereceiver/go.mod
diff --git a/receiver/windowsservicereciever/go.sum → receiver/windowsservicereceiver/go.sum b/receiver/windowsservicereciever/go.sum → receiver/windowsservicereceiver/go.sum
diff --git a/...ver/internal/metadata/generated_config.go → ...ver/internal/metadata/generated_config.go b/...ver/internal/metadata/generated_config.go → ...ver/internal/metadata/generated_config.go
diff --git a/...nternal/metadata/generated_config_test.go → ...nternal/metadata/generated_config_test.go b/...nternal/metadata/generated_config_test.go → ...nternal/metadata/generated_config_test.go
diff --git a/...er/internal/metadata/generated_metrics.go → ...er/internal/metadata/generated_metrics.go b/...er/internal/metadata/generated_metrics.go → ...er/internal/metadata/generated_metrics.go
diff --git a/...ternal/metadata/generated_metrics_test.go → ...ternal/metadata/generated_metrics_test.go b/...ternal/metadata/generated_metrics_test.go → ...ternal/metadata/generated_metrics_test.go
diff --git a/...ver/internal/metadata/generated_status.go → ...ver/internal/metadata/generated_status.go b/...ver/internal/metadata/generated_status.go → ...ver/internal/metadata/generated_status.go
diff --git a/...er/internal/metadata/testdata/config.yaml → ...er/internal/metadata/testdata/config.yaml b/...er/internal/metadata/testdata/config.yaml → ...er/internal/metadata/testdata/config.yaml
diff --git a/...iver/windowsservicereciever/metadata.yaml → ...iver/windowsservicereceiver/metadata.yaml b/...iver/windowsservicereciever/metadata.yaml → ...iver/windowsservicereceiver/metadata.yaml
@@ -35,4 +35,7 @@ metrics:
     unit: '{status}'
     gauge:
       value_type: int
-    attributes: [windows.service.name, windows.service.startup_mode]
+    attributes: [windows.service.name, windows.service.startup_mode]
+
+tests:
+  config:
diff --git a/receiver/windowsservicereciever/scraper.go → receiver/windowsservicereceiver/scraper.go b/receiver/windowsservicereciever/scraper.go → receiver/windowsservicereceiver/scraper.go
diff --git a/...er/windowsservicereciever/scraper_test.go → ...er/windowsservicereceiver/scraper_test.go b/...er/windowsservicereciever/scraper_test.go → ...er/windowsservicereceiver/scraper_test.go
diff --git a/receiver/windowsservicereciever/winapi.go → receiver/windowsservicereceiver/winapi.go b/receiver/windowsservicereciever/winapi.go → receiver/windowsservicereceiver/winapi.go
diff --git a/...ver/windowsservicereciever/winapi_test.go → ...ver/windowsservicereceiver/winapi_test.go b/...ver/windowsservicereciever/winapi_test.go → ...ver/windowsservicereceiver/winapi_test.go