Skip to content

cleanup Intel RDT readme#8268

Merged
sjwang90 merged 2 commits intomasterfrom
intel_rdt-readme
Oct 15, 2020
Merged

cleanup Intel RDT readme#8268
sjwang90 merged 2 commits intomasterfrom
intel_rdt-readme

Conversation

@sjwang90
Copy link
Copy Markdown
Contributor

Great detailed README but some feedback from some of our documentation folks to make this README a little clearer/cleaner.

@p-zak Please review

## This value is propagated to pqos tool. Interval format is defined by pqos itself.
## If not provided or provided 0, will be set to 10 = 10x100ms = 1s.
# sampling_interval = "10"
[[inputs.intel_rdt]]
Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@p-zak can you clarify the name of this plugin? Will need to be updated in the SampleConfig() section of intel_rdt.go

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I will check that.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

fyi this plugin name line doesn't go in SampleConfig.

Copy link
Copy Markdown
Collaborator

@p-zak p-zak Oct 15, 2020

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@sjwang90 Yes, it should be intel_rdt. I think it should also be changed in https://github.com/influxdata/telegraf/blob/master/plugins/inputs/intel_rdt/intel_rdt.go#L544 and we are all set :)

@sjwang90 sjwang90 added the docs Issues related to Telegraf documentation and configuration descriptions label Oct 14, 2020
@p-zak
Copy link
Copy Markdown
Collaborator

p-zak commented Oct 14, 2020

@sjwang90 looks much nicer, thank you. I still need check one or two things, can we back to it tomorrow?

@sjwang90
Copy link
Copy Markdown
Contributor Author

Yeah no rush!

@p-zak
Copy link
Copy Markdown
Collaborator

p-zak commented Oct 15, 2020

@sjwang90 LGTM!

@sjwang90
Copy link
Copy Markdown
Contributor Author

Thanks @p-zak! If you see any thing that needs to be changed intel_rdt.go feel free to open a PR yourself.

Heads up @ssoroka, I'm gonna merge this.

@sjwang90 sjwang90 merged commit 4872d7b into master Oct 15, 2020
@sjwang90 sjwang90 deleted the intel_rdt-readme branch October 15, 2020 16:09
ssoroka pushed a commit that referenced this pull request Oct 15, 2020
* cleanup Intel RDT readme

* Update intel_rdt.go
arstercz pushed a commit to arstercz/telegraf that referenced this pull request Mar 5, 2023
* cleanup Intel RDT readme

* Update intel_rdt.go
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

docs Issues related to Telegraf documentation and configuration descriptions

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants