Skip to content

Commit

Permalink
Fixed markdown lints
Browse files Browse the repository at this point in the history
  • Loading branch information
BenMatase committed Dec 18, 2023
1 parent e40712f commit 9d59ffc
Show file tree
Hide file tree
Showing 8 changed files with 289 additions and 288 deletions.
2 changes: 1 addition & 1 deletion .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
### Required for all PRs:
# Required for all PRs

<!-- Complete the tasks in the following list. Change [ ] to [x] to
show completion. -->
Expand Down
12 changes: 6 additions & 6 deletions 128tech.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ When moving to a new upstream version, things are a little more complicated. It

First, pull down the new upstream branch. Then, determine what's been added locally and needs to be included in the new custom build. Do this by finding the commits that were added in the custom branch. This example uses release 1.14, but that will change as time passes.

```
```shell
git log --no-merges --left-right --graph --cherry-pick --oneline release-1.14..release-128tech-1.14 | tail -r
```

Expand All @@ -25,34 +25,34 @@ That should provide a limited number of commits that will need to be cherry-pick

Building a new RPM should be straight forward. The necessary building environments exist in the CI docker containers. There is a script `./scripts/docker-env` that wraps docker commands for easy use. To build an RPM from the current source code (example versioning used), simply run:

```
```shell
./scripts/docker-env build --version 1.13.1 --release 2
```

This will produce new RPMs and place them into the `build` directory.

```
```shell
./scripts/docker-env build --version 1.13.1 --release 3 --no-fetch
```

## Using the Shell

While not a comprehensive guide, this will get you started. You can drop into the docker environment by running:

```
```shell
./scripts/docker-env shell
```

From there, you can use `go` and the Telegraf `make` commands as desired. For a few examples, to run all the tests, simply run:

```
```shell
go get -v -t -d ./...
go test -short ./...
```

or to run a single plugin's tests, run

```
```shell
go get -v -t -d ./...
go test ./plugins/outputs/http/
```
1 change: 0 additions & 1 deletion CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -82,7 +82,6 @@

- [#10462](https://github.com/influxdata/telegraf/pull/10462) `external.psi` Add psi plugin


## v1.22.0

### Influx Line Protocol Parser
Expand Down
538 changes: 270 additions & 268 deletions README.md

Large diffs are not rendered by default.

6 changes: 3 additions & 3 deletions plugins/inputs/t128_graphql/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -52,7 +52,7 @@ The graphql input plugin collects data from a 128T instance via graphQL.

For the configuration above, the plugin will build the following graphQL query:

```
```graphql
query {
allRouters(name: "RTR_EAST_COMBO") {
nodes {
Expand All @@ -77,7 +77,7 @@ query {

For the query above, an example graphQL response is:

```
```json
{
"data": {
"allRouters": {
Expand Down Expand Up @@ -115,7 +115,7 @@ For the query above, an example graphQL response is:

For the response above, the collector outputs:

```
```text
peer-paths,router-name=RTR_EAST_COMBO,device-interface=10,peer-name=fake other="foo",is-active=true,status="DOWN" 1617285085000000000
peer-paths,router-name=RTR_EAST_COMBO,device-interface=11,peer-name=fake other="foo",is-active=true,status="UP" 1617285085000000000
```
2 changes: 1 addition & 1 deletion plugins/inputs/t128_metrics/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

The metrics input plugin collects metrics from a 128T instance.

### Configuration
## Configuration

```toml
# Read metrics from a 128T instance
Expand Down
10 changes: 5 additions & 5 deletions plugins/processors/t128_pass/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ The `t128_filter` filters out metrics passing through it. This processor is usef

[Metric selectors](docs/CONFIGURATION.md#selectors) (such as `tagpass` and `tagdrop`) can be used to only apply the filters to specific metrics.

### Configuration:
## Configuration

```toml
[[processors.t128_filter]]
Expand Down Expand Up @@ -47,7 +47,7 @@ The `t128_filter` filters out metrics passing through it. This processor is usef
# tag1 = ["value3"]
```

### Basic Example Filter:
### Basic Example Filter

Multiple values for a specific tag are OR'd together. A metric without a tag is also dropped.

Expand All @@ -66,7 +66,7 @@ measurement tag1=value2 1612214810000000000
- measurement 1612214805000000000
```

### Multiple Keys Example Filter:
### Multiple Keys Example Filter

Multiple keys are AND'd together.

Expand All @@ -86,7 +86,7 @@ measurement tag1=value1,tag2=value2 1612214810000000000
- measurement tag1=value1,tag2=value3 1612214805000000000
```

### Multiple Conditions Example Filter:
### Multiple Conditions Example Filter

Multiple conditions are OR'd together.

Expand All @@ -109,7 +109,7 @@ measurement tag1=value2 1612214810000000000
- measurement tag1=value3 1612214810000000000
```

### Basic Field Example Filter:
### Basic Field Example Filter

Fields can also be filtered on by themselves or AND'd together with tags.

Expand Down
6 changes: 3 additions & 3 deletions plugins/processors/t128_transform/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

The `t128_transform` transforms metrics based on the difference between two observed points.

### Configuration:
## Configuration

```toml
[[processors.t128_transform]]
Expand All @@ -25,7 +25,7 @@ The `t128_transform` transforms metrics based on the difference between two obse
# "/inline/replace" = "/inline/replace"
```

### Example Diff:
### Example Diff

```toml
[[processors.t128_transform]]
Expand All @@ -41,7 +41,7 @@ The `t128_transform` transforms metrics based on the difference between two obse
+ measurement diff=5i 1612214810000000000
```

### Example Rate:
### Example Rate

```toml
[[processors.t128_transform]]
Expand Down

0 comments on commit 9d59ffc

Please sign in to comment.