Skip to content

Commit

Permalink
[O11y][Golang] Fix description in README.md (#7850)
Browse files Browse the repository at this point in the history
* Fix descriptions in README.md.

* update changelog.yml

* address review comments

* Update packages/golang/changelog.yml

Co-authored-by: subham sarkar <sarkar.subhams2@gmail.com>

* minor nit

* Update packages/golang/manifest.yml

---------

Co-authored-by: subham sarkar <sarkar.subhams2@gmail.com>
  • Loading branch information
harnish-elastic and shmsr committed Sep 25, 2023
1 parent bc498fa commit 26b822d
Show file tree
Hide file tree
Showing 4 changed files with 13 additions and 8 deletions.
6 changes: 3 additions & 3 deletions packages/golang/_dev/build/docs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,8 +12,8 @@ Use the Golang integration to:

The Golang integration collects metrics using [expvar](https://pkg.go.dev/expvar) package. Metrics are exported on "/debug/vars" endpoint after [importing](https://pkg.go.dev/expvar#:~:text=into%20your%20program%3A-,import%20_%20%22expvar%22,-Index%20%C2%B6) expvar package and adding an HTTP handler.

**Logs** help you keep a record of state of Golang application.
Log data streams collected by the Golang integration include [expvar](https://pkg.go.dev/expvar) and [Heap](https://go.dev/src/runtime/mstats.go#:~:text=118%20119%20%2F%2F%20HeapAlloc%20is%20bytes%20of%20allocated%20heap%20objects.).
**Metrics** help you keep a record of the state of the Go (Golang) application.
Metric data streams collected by the Golang integration include [expvar](https://pkg.go.dev/expvar) and [heap](https://go.dev/src/runtime/mstats.go).

Data streams:
- `heap`: Collects heap metrics like heap allocation and garbage collection metrics.
Expand Down Expand Up @@ -129,7 +129,7 @@ DELETE temp_index

More details about reindexing can be found [here](https://www.elastic.co/guide/en/elasticsearch/reference/current/docs-reindex.html).

## Logs reference
## Metrics reference

### expvar

Expand Down
5 changes: 5 additions & 0 deletions packages/golang/changelog.yml
Original file line number Diff line number Diff line change
@@ -1,4 +1,9 @@
# newer versions go on top
- version: "0.4.4"
changes:
- description: Fix description in README.md.
type: bugfix
link: https://github.com/elastic/integrations/pull/7850
- version: "0.4.3"
changes:
- description: Add null check and ignore_missing check to the rename processor
Expand Down
6 changes: 3 additions & 3 deletions packages/golang/docs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,8 +12,8 @@ Use the Golang integration to:

The Golang integration collects metrics using [expvar](https://pkg.go.dev/expvar) package. Metrics are exported on "/debug/vars" endpoint after [importing](https://pkg.go.dev/expvar#:~:text=into%20your%20program%3A-,import%20_%20%22expvar%22,-Index%20%C2%B6) expvar package and adding an HTTP handler.

**Logs** help you keep a record of state of Golang application.
Log data streams collected by the Golang integration include [expvar](https://pkg.go.dev/expvar) and [Heap](https://go.dev/src/runtime/mstats.go#:~:text=118%20119%20%2F%2F%20HeapAlloc%20is%20bytes%20of%20allocated%20heap%20objects.).
**Metrics** help you keep a record of the state of the Go (Golang) application.
Metric data streams collected by the Golang integration include [expvar](https://pkg.go.dev/expvar) and [heap](https://go.dev/src/runtime/mstats.go).

Data streams:
- `heap`: Collects heap metrics like heap allocation and garbage collection metrics.
Expand Down Expand Up @@ -129,7 +129,7 @@ DELETE temp_index

More details about reindexing can be found [here](https://www.elastic.co/guide/en/elasticsearch/reference/current/docs-reindex.html).

## Logs reference
## Metrics reference

### expvar

Expand Down
4 changes: 2 additions & 2 deletions packages/golang/manifest.yml
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
format_version: 2.0.0
name: golang
title: Golang
version: "0.4.3"
description: This Elastic integration collects metrics from Golang applications.
version: "0.4.4"
description: This Elastic integration collects metrics from Go (Golang) applications.
type: integration
categories:
- observability
Expand Down

0 comments on commit 26b822d

Please sign in to comment.