From 8be58fee10c579fd25190069f81690e14a5d0cdd Mon Sep 17 00:00:00 2001 From: DeDe Morton Date: Tue, 14 Aug 2018 02:44:17 -0700 Subject: [PATCH] Replace golang with Go (#7948) I've been told that using "golang" instead of "Go" is considered a faux pas in some circles. :-) I've replaced instances in the external docs, but I did not update the changelog, readmes, or code files. --- docs/devguide/contributing.asciidoc | 4 ++-- docs/devguide/create-metricset.asciidoc | 4 ++-- .../creating-beat-from-metricbeat.asciidoc | 2 +- docs/devguide/metricset-details.asciidoc | 4 ++-- docs/devguide/modules-dev-guide.asciidoc | 2 +- docs/devguide/newbeat.asciidoc | 2 +- docs/devguide/newdashboards.asciidoc | 2 +- docs/devguide/testing.asciidoc | 22 +++++++++---------- filebeat/docs/getting-started.asciidoc | 2 +- filebeat/docs/inputs/input-log.asciidoc | 6 ++--- libbeat/docs/outputconfig.asciidoc | 4 ++-- libbeat/docs/overview.asciidoc | 8 +++---- metricbeat/docs/fields.asciidoc | 6 ++--- .../module/golang/expvar/_meta/docs.asciidoc | 2 +- .../module/golang/expvar/_meta/fields.yml | 2 +- metricbeat/module/golang/fields.go | 2 +- .../module/golang/heap/_meta/fields.yml | 4 ++-- 17 files changed, 39 insertions(+), 39 deletions(-) diff --git a/docs/devguide/contributing.asciidoc b/docs/devguide/contributing.asciidoc index eab4ff520ac..1bb22810ec9 100644 --- a/docs/devguide/contributing.asciidoc +++ b/docs/devguide/contributing.asciidoc @@ -45,8 +45,8 @@ Beats]. === Setting Up Your Dev Environment The Beats are Go programs, so install the latest version of -http://golang.org/[golang] if you don't have it already. The current Go version -used for development is Golang {go-version}. +http://golang.org/[Go] if you don't have it already. The current Go version +used for development is Go {go-version}. The location where you clone is important. Please clone under the source directory of your `GOPATH`. If you don't have `GOPATH` already set, you can diff --git a/docs/devguide/create-metricset.asciidoc b/docs/devguide/create-metricset.asciidoc index 94c9531ce19..e39cd9f6366 100644 --- a/docs/devguide/create-metricset.asciidoc +++ b/docs/devguide/create-metricset.asciidoc @@ -69,13 +69,13 @@ https://github.com/elastic/beats/blob/master/metricbeat/scripts/module/metricset include::../../metricbeat/scripts/module/metricset/metricset.go.tmpl[] ---- -The `package` clause and `import` declaration are part of the base structure of each Golang file. You should only +The `package` clause and `import` declaration are part of the base structure of each Go file. You should only modify this part of the file if your implementation requires more imports. [float] ===== Initialisation -The init method registers the metricset with the central registry. In Golang the `init()` function is called +The init method registers the metricset with the central registry. In Go the `init()` function is called before the execution of all other code. This means the module will be automatically registered with the global registry. The `New` method, which is passed to `AddMetricSet`, will be called after the setup of the module and before starting to fetch data. You normally don't need to change this part of the file. diff --git a/docs/devguide/creating-beat-from-metricbeat.asciidoc b/docs/devguide/creating-beat-from-metricbeat.asciidoc index 62f437234e8..787f61a0a57 100644 --- a/docs/devguide/creating-beat-from-metricbeat.asciidoc +++ b/docs/devguide/creating-beat-from-metricbeat.asciidoc @@ -7,7 +7,7 @@ own metricsets. [float] ==== Requirements -To create your own Beat, you must have Golang {go-version} or later installed, and the `$GOPATH` +To create your own Beat, you must have Go {go-version} or later installed, and the `$GOPATH` must be set up correctly. In addition, the following tools are required: * https://www.python.org/downloads/[python] diff --git a/docs/devguide/metricset-details.asciidoc b/docs/devguide/metricset-details.asciidoc index 126454a55d1..e3358ec7afb 100644 --- a/docs/devguide/metricset-details.asciidoc +++ b/docs/devguide/metricset-details.asciidoc @@ -145,8 +145,8 @@ It's important to also add tests for your metricset. There are three different t * system tests We recommend that you use all three when you create a metricset. Unit tests are -written in Golang and have no dependencies. Integration tests are also written -in Golang but require the service from which the module collects metrics to also be running. +written in Go and have no dependencies. Integration tests are also written +in Go but require the service from which the module collects metrics to also be running. System tests for Metricbeat also require the service to be running in most cases and are written in Python based on our small Python test framework. We use `virtualenv` to deal with Python dependencies. diff --git a/docs/devguide/modules-dev-guide.asciidoc b/docs/devguide/modules-dev-guide.asciidoc index 04f272959ec..7fc1e5e10b1 100644 --- a/docs/devguide/modules-dev-guide.asciidoc +++ b/docs/devguide/modules-dev-guide.asciidoc @@ -260,7 +260,7 @@ input configuration are documented in the the Filebeat documentation. The template files use the templating language defined by the -https://golang.org/pkg/text/template/[Golang standard library]. +https://golang.org/pkg/text/template/[Go standard library]. Here is another example that also configures multiline stitching: diff --git a/docs/devguide/newbeat.asciidoc b/docs/devguide/newbeat.asciidoc index c421eafdff7..8565d323131 100644 --- a/docs/devguide/newbeat.asciidoc +++ b/docs/devguide/newbeat.asciidoc @@ -77,7 +77,7 @@ daemonzing, and Windows service handling, and data processing modules. image:./images/beat_overview.png[Beat overview architecture] -The event that you create is a JSON-like object (Golang type `map[string]interface{}`) that +The event that you create is a JSON-like object (Go type `map[string]interface{}`) that contains the collected data to send to the publisher. At a minimum, the event object must contain a `@timestamp` field and a `type` field. Beyond that, events can contain any additional fields, and they can be created as often diff --git a/docs/devguide/newdashboards.asciidoc b/docs/devguide/newdashboards.asciidoc index 9cfd5aa5327..b874dafbfe3 100644 --- a/docs/devguide/newdashboards.asciidoc +++ b/docs/devguide/newdashboards.asciidoc @@ -208,7 +208,7 @@ make update === Exporting New and Modified Beat Dashboards To export all the dashboards for any Elastic Beat or any community Beat, including any new or modified dashboards and all dependencies such as -visualizations, searches, you can use the Golang script `export_dashboards.go` from +visualizations, searches, you can use the Go script `export_dashboards.go` from https://github.com/elastic/beats/tree/master/dev-tools/cmd/dashboards[dev-tools] for exporting Kibana 6.0 dashboards or later, and the Python script `export_5x_dashboards.py` for exporting Kibana 5.x dashboards. See the dev-tools https://github.com/elastic/beats/tree/master/dev-tools/README.md[readme] for more info. diff --git a/docs/devguide/testing.asciidoc b/docs/devguide/testing.asciidoc index 0e548de333e..3091cd01cd7 100644 --- a/docs/devguide/testing.asciidoc +++ b/docs/devguide/testing.asciidoc @@ -5,20 +5,20 @@ Beats has a various sets of tests. This guide should help to understand how the In general there are two major test suites: -* Tests written in Golang +* Tests written in Go * Tests written in Python -The tests written in Golang use the https://golang.org/pkg/testing/[Golang Testing package]. The tests written in Python depend on http://nose.readthedocs.io/en/latest/[nosetests] and require a compiled and executable binary from the Golang code. The python test run a beat with a specific config and params and either check if the output is as expected or if the correct things show up in the logs. +The tests written in Go use the https://golang.org/pkg/testing/[Go Testing package]. The tests written in Python depend on http://nose.readthedocs.io/en/latest/[nosetests] and require a compiled and executable binary from the Go code. The python test run a beat with a specific config and params and either check if the output is as expected or if the correct things show up in the logs. For both of the above test suites so called integration tests exists. Integration tests in Beats are tests which require an external system like Elasticsearch to test if the integration with this service works as expected. Beats provides in its testsuite docker containers and docker-compose files to start these environments but a developer can run the required services also locally. -==== Running Golang Tests +==== Running Go Tests -The golang tests can be executed in each Golang package by running `go test .`. This will execute all tests which don't don't require an external service to be running. To also run the Golang integration tests run `go test -tags=integration .`. It will require you to run the expected services on localhost. +The Go tests can be executed in each Go package by running `go test .`. This will execute all tests which don't don't require an external service to be running. To also run the Go integration tests run `go test -tags=integration .`. It will require you to run the expected services on localhost. To run all non integration tests for a beat run `make unit`. This will execute all the tests which are not inside a `vendor` directory. If you want to have a coverage report for the tests which were run use `make unit-tests`. A coverage report will be generated under `build/coverage` directory. -All Golang tests are in the same package as the tested code itself and have the postfix `_test` in the file name. Most of the tests are in the same package as the rest of the code. Some of the tests which should be separate from the rest of the code or should not use private variables go under `{packagename}_test`. +All Go tests are in the same package as the tested code itself and have the postfix `_test` in the file name. Most of the tests are in the same package as the rest of the code. Some of the tests which should be separate from the rest of the code or should not use private variables go under `{packagename}_test`. ==== Running Python Tests @@ -37,10 +37,10 @@ All Python tests are under `tests/system` directory. This is a quick summary of the available test commands: -* `unit`: Golang tests -* `unit-tests`: Golang tests with coverage reports -* `integration-tests`: Golang tests with services in local docker -* `integration-tests-environment`: Golang tests inside docker with service in docker +* `unit`: Go tests +* `unit-tests`: Go tests with coverage reports +* `integration-tests`: Go tests with services in local docker +* `integration-tests-environment`: Go tests inside docker with service in docker * `fast-system-tests`: Python tests * `system-tests`: Python tests with coverage report * `INTEGRATION_TESTS=1 system-tests`: Python tests with local services @@ -50,7 +50,7 @@ This is a quick summary of the available test commands: There are two experimental test commands: -* `benchmark-tests`: Running golang tests with `-bench` flag +* `benchmark-tests`: Running Go tests with `-bench` flag * `load-tests`: Running system tests with `LOAD_TESTS=1` flag @@ -60,7 +60,7 @@ If the tests were run to create a test coverage, the coverage report files can b ==== Race detection -All tests can be run with the Golang race detector enabled by setting the environment variable `RACE_DETECTOR=1`. This applies to tests in Golang and Python. For Python the test binary has to be recompile when the flag is changed. Having the race detection enabled will slow down the tests. +All tests can be run with the Go race detector enabled by setting the environment variable `RACE_DETECTOR=1`. This applies to tests in Go and Python. For Python the test binary has to be recompile when the flag is changed. Having the race detection enabled will slow down the tests. ==== Docker environment diff --git a/filebeat/docs/getting-started.asciidoc b/filebeat/docs/getting-started.asciidoc index 33e15b65c99..81f88a92d3a 100644 --- a/filebeat/docs/getting-started.asciidoc +++ b/filebeat/docs/getting-started.asciidoc @@ -166,7 +166,7 @@ filebeat.inputs: + The input in this example harvests all files in the path `/var/log/*.log`, which means that Filebeat will harvest all files in the directory `/var/log/` that end with `.log`. All patterns supported -by https://golang.org/pkg/path/filepath/#Glob[Golang Glob] are also supported here. +by https://golang.org/pkg/path/filepath/#Glob[Go Glob] are also supported here. + To fetch all files from a predefined level of subdirectories, the following pattern can be used: `/var/log/*/*.log`. This fetches all `.log` files from the subfolders of `/var/log`. It does not diff --git a/filebeat/docs/inputs/input-log.asciidoc b/filebeat/docs/inputs/input-log.asciidoc index 7c73c63d396..b91b98020a4 100644 --- a/filebeat/docs/inputs/input-log.asciidoc +++ b/filebeat/docs/inputs/input-log.asciidoc @@ -7,10 +7,10 @@ Log ++++ -Use the `log` input to read lines from log files. +Use the `log` input to read lines from log files. To configure this input, specify a list of glob-based <> -that must be crawled to locate and fetch the log lines. +that must be crawled to locate and fetch the log lines. Example configuration: @@ -69,7 +69,7 @@ The `log` input supports the following configuration options plus the ===== `paths` A list of glob-based paths that will be crawled and fetched. All patterns -supported by https://golang.org/pkg/path/filepath/#Glob[Golang Glob] are also +supported by https://golang.org/pkg/path/filepath/#Glob[Go Glob] are also supported here. For example, to fetch all files from a predefined level of subdirectories, the following pattern can be used: `/var/log/*/*.log`. This fetches all `.log` files from the subfolders of `/var/log`. It does not diff --git a/libbeat/docs/outputconfig.asciidoc b/libbeat/docs/outputconfig.asciidoc index 187ab171db0..735a5cecb00 100644 --- a/libbeat/docs/outputconfig.asciidoc +++ b/libbeat/docs/outputconfig.asciidoc @@ -14,7 +14,7 @@ == Configure the output ifdef::only-elasticsearch[] -You configure {beatname_uc} to write to Elasticsearch by setting options +You configure {beatname_uc} to write to Elasticsearch by setting options in the `output.elasticsearch` section of the +{beatname_lc}.yml+ config file endif::[] @@ -207,7 +207,7 @@ The URL of the proxy to use when connecting to the Elasticsearch servers. The value may be either a complete URL or a "host[:port]", in which case the "http" scheme is assumed. If a value is not specified through the configuration file then proxy environment variables are used. See the -https://golang.org/pkg/net/http/#ProxyFromEnvironment[golang documentation] +https://golang.org/pkg/net/http/#ProxyFromEnvironment[Go documentation] for more information about the environment variables. [[index-option-es]] diff --git a/libbeat/docs/overview.asciidoc b/libbeat/docs/overview.asciidoc index 332115a4bac..55f8eb280a5 100644 --- a/libbeat/docs/overview.asciidoc +++ b/libbeat/docs/overview.asciidoc @@ -13,9 +13,9 @@ for capturing: Audit data:: https://www.elastic.co/products/beats/auditbeat[Auditbeat] Log files:: https://www.elastic.co/products/beats/filebeat[Filebeat] Availability:: https://www.elastic.co/products/beats/heartbeat[Heartbeat] -Metrics:: https://www.elastic.co/products/beats/metricbeat[Metricbeat] -Network traffic:: https://www.elastic.co/products/beats/packetbeat[Packetbeat] -Windows event logs:: https://www.elastic.co/products/beats/winlogbeat[Winlogbeat] +Metrics:: https://www.elastic.co/products/beats/metricbeat[Metricbeat] +Network traffic:: https://www.elastic.co/products/beats/packetbeat[Packetbeat] +Windows event logs:: https://www.elastic.co/products/beats/winlogbeat[Winlogbeat] {beats} can send data directly to {es} or via https://www.elastic.co/products/logstash[{ls}], where you can further process @@ -31,7 +31,7 @@ To get started, see <>. If you have a specific use case to solve, we encourage you to create a <>. We've created an infrastructure to simplify -the process. The _libbeat_ library, written entirely in Golang, offers the API +the process. The _libbeat_ library, written entirely in Go, offers the API that all Beats use to ship data to Elasticsearch, configure the input options, implement logging, and more. To learn how to create a new Beat, see the {beatsdevguide}/index.html[Beats Developer Guide]. diff --git a/metricbeat/docs/fields.asciidoc b/metricbeat/docs/fields.asciidoc index 6e901c30de4..0842d889023 100644 --- a/metricbeat/docs/fields.asciidoc +++ b/metricbeat/docs/fields.asciidoc @@ -5239,7 +5239,7 @@ expvar -- type: keyword -The cmdline of this golang program start with. +The cmdline of this Go program start with. -- @@ -5247,7 +5247,7 @@ The cmdline of this golang program start with. [float] == heap fields -The golang program heap information exposed by expvar. +The Go program heap information exposed by expvar. @@ -5256,7 +5256,7 @@ The golang program heap information exposed by expvar. -- type: keyword -The cmdline of this golang program start with. +The cmdline of this Go program start with. -- diff --git a/metricbeat/module/golang/expvar/_meta/docs.asciidoc b/metricbeat/module/golang/expvar/_meta/docs.asciidoc index 7dee43fa0ed..49e126d70d2 100644 --- a/metricbeat/module/golang/expvar/_meta/docs.asciidoc +++ b/metricbeat/module/golang/expvar/_meta/docs.asciidoc @@ -1,2 +1,2 @@ This is the `expvar` metricset of the Golang module. -Golang can expose its variables by the expvar API. With this metricset, you can collect all the expvar-exposed variables. +Go can expose its variables by the expvar API. With this metricset, you can collect all the expvar-exposed variables. diff --git a/metricbeat/module/golang/expvar/_meta/fields.yml b/metricbeat/module/golang/expvar/_meta/fields.yml index b316b60508e..02b88ca43f1 100644 --- a/metricbeat/module/golang/expvar/_meta/fields.yml +++ b/metricbeat/module/golang/expvar/_meta/fields.yml @@ -7,4 +7,4 @@ - name: cmdline type: keyword description: > - The cmdline of this golang program start with. + The cmdline of this Go program start with. diff --git a/metricbeat/module/golang/fields.go b/metricbeat/module/golang/fields.go index 83dd1493a08..86e5ebdfc1b 100644 --- a/metricbeat/module/golang/fields.go +++ b/metricbeat/module/golang/fields.go @@ -31,5 +31,5 @@ func init() { // Asset returns asset data func Asset() string { - return "eJzkV9tu40YMffdXEHnKokk+wEAX2Lqo+9CmBdIWBYrCoCVKmmYuwpCyrb8vZiQ5jiJp5WwCF1s9KSOHPOfwMuQtPFK9hNxptPkCQJRoWsLVOh5cLQBS4sSrUpSzS/i4AABoPoJxaaVpAcCF87JJnM1UvoQMNYdTT5qQaQlbEgy/IhFlc17CX1fM+urvBUCmSKe8jFZvwaKhEyzhkboMR95VZXsygOe5nVNbdCh36I/HQ/ZGbTbPCwt9Wt3Th3AKIzGpVpaefeuwPFK9dz7tfZtAFJ7fCuqMgstACsWtblB6l3s0wIJeYK+kuHshS0FYfokowX3PXTAJymbOGwz/EoRzTCls61bDu69ExEFweTKIq6/pDFRr9FvMCRKnNSXiPHBlDPr6rvfTIa1OIYkT1JsSK+5rNo1vBsZGvmAf1iuILiCtfBN4tyMPWmUkykRhS+8SYu7jn+JwysPysP+WgnbHZvEaFgDwfYdcWbgfgPlc0MRVVkYFHUEzX09bmS35INt6BXtkKLAsyVI6jsvSQTZ5stHKqLORNQW7hG0tNCT0HOT3dJAuX4OOe6V1ixv2BVn4kbD8pLVL4GNTZmiCiuOUkrLaZB6juVFGmXY4xHcO5B9a40Ho1a+/Q8zVqu1X69U4sverp5+Q5WU5cXhTNgcpCIyzSlz8sySv3EBSzKupsSSGNywrWAUnbSb3esSRk+IucSYYPeHmykyiHtP/HNhjfe1czNORgDkdDuaE4xxuM7rdKTCDh3eX+2c8fL1in6U27sa8vp3an3bkw3Tx/1N8cGzjmoX6LeXVo1u45rpp7WZfqKRortV4j7utoLKUQuadaR2/aqS7wA3ftMSGyxAPuObKhE7/5+HwUDNsSbv9h/FLtLNxASp/KIxxeqj5ZoLRXVxoNlwzfNu8qlQTfNO+24ppnB4LJo8X4PZdpNNNMREFYBi7UJy/AbRpmCKYzszKJ2Lt2naJuDXcOgAgLg5Evzx8psBb+mGQetMqP7H72v3MRBtDcnzpKnF/3CFaH+MRzTwNRuTtIEQPU63gH0rkPSD096k2ZJR2Pj+z6V0syZ+AXtOOLKhGxPQDSOFdlReukpj93ZI9TuRo6j9AJrQf6wRqkoYPXDMaAmRodkPcuh1N3BqhA1+Mh7LRP3CJdiJzwla5uyhK6+ztEend4t8AAAD//8IfSX8=" + return "eJzkV91u60QQvs9TjHrVI9o+QCSOdAgiXEBBKiAkhKKJPbaX7u5YO+skfnu0aztNXdvH6WkVdPBVsrZmvu+bn525hUeql5CzRpsvALzympZwtY4HVwuAlCRxqvSK7RI+LgAAmpdgOK00LQCkYOc3CdtM5UvIUEs4daQJhZawJY/hK/Je2VyW8NeViL76ewGQKdKpLKPVW7Bo6ARLeHxdhiPHVdmeDOB5bufUFh3KHbrj8ZC9UZvN88JCn1b39CGcwkhMqpWlZ+86LI9U79mlvXcTiMLzW0GdUeAMfKEE1gyl49yhAfHoPOyVL+5eSFIQll8iSHB94iqYA2UzdgbD50EwFkphW7fa3X0F4g0Cy5NBTH0tZyBao9tiTpCw1pR4diCVMejqu96nQzqdQvLsUW9KrKSv1zS+GRgb6YJ9WK8guoC0ck3QeUcOtMrIKxNFLR0nJNLHP8XhlIeVYf8tBc3HBvEaFgDwfYdcWbgfgPlc0IQr60cFHUEzX09bmS25INt6BXsUKLAsyVI6jsvSwW/yZKOVUWcja4p1Cdva05DQc5Df08F3+Rp03CutW9ywL8jCj4TlJ605gY9NiaEJKo5TSspqkzmM5kYZZZpxiO8cyD+0xoPQq19/h5irVdur1qtxZO9XTz+h+JflJOGXsjn4gsCwVZ7j35Kc4oGkmFdTY0kMb1hWsApO2kzu9YgjJyVd4kwwesItlZlEPab/ObDH+tq5mKcjAXM6HMwJxzncZnS7U2AGD+8u9894+HrFPktt3I15fTu1P+3Iheni/6f44NgmtXjqt5RXj27hmuumtZt9oZKiuVbjPc5bj8pSCplj0zp+1Uh3gRu+aYkNlyEecC2VCZ3+z8PhoRbYkub9h/FLtLNxASp/KIxxeqjlZoLRXVxmNlILfNv8VKkm+Kb9bSuhcXriMXm8ALfvIp1uiokoAMPYhZ7dDaBNwxQhdGZWPhFrV7ZLxK3h1gEAz3Eg+uXhMwXe0g+D1JtW+Ynd1+5nJtoYkuNLV4n74w7R+hiPaOZoMCJvByF6mGoF/1Di3wNCf59qQ0Zp5/Mzm97FkvwJ6DXtyIJqREw/gC8cV3nBlY/Z3y3Z40SOpv4DZEL7seyhJt/wgWtBQ4ACzW6IW97RxK0ROvDFeCgb/YOUaCcyJ2yVu4uitGxvj0jvFv8GAAD//zhDRDk=" } diff --git a/metricbeat/module/golang/heap/_meta/fields.yml b/metricbeat/module/golang/heap/_meta/fields.yml index 70715dce3e8..4bf3742bae7 100644 --- a/metricbeat/module/golang/heap/_meta/fields.yml +++ b/metricbeat/module/golang/heap/_meta/fields.yml @@ -1,13 +1,13 @@ - name: heap type: group description: > - The golang program heap information exposed by expvar. + The Go program heap information exposed by expvar. release: beta fields: - name: cmdline type: keyword description: > - The cmdline of this golang program start with. + The cmdline of this Go program start with. - name: gc type: group