chore: Fix typos throughout codebase #15338

szepeviktor · 2024-05-10T16:33:45Z

Summary

Found few misspellings.

Checklist

No AI generated code was used in this PR

Please be gentle with me, I've gone through 500k lines.

telegraf-tiger · 2024-05-10T16:33:50Z

Thanks so much for the pull request!
🤝 ✒️ Just a reminder that the CLA has not yet been signed, and we'll need it before merging. Please sign the CLA when you get a chance, then post a comment here saying !signed-cla

powersj · 2024-05-10T16:38:48Z

Hi,

I am AI robot 🙃

Please don't mess with the checklist. We do need that checked and accurate.

Also as the bot said, please do sign the CLA and let us know when you do.

Thanks

szepeviktor · 2024-05-10T16:41:00Z

I am sorry.

szepeviktor · 2024-05-10T16:42:30Z

please do sign the CLA and let us know when you do.

Submitted 🍏

powersj · 2024-05-10T16:44:05Z

!signed-cla

I am sorry.

No worries!

powersj · 2024-05-10T16:45:32Z

!signed-cla

srebhan

Thanks @szepeviktor for your contribution and effort! Please do not change TOML tags as this will break compatibility to existing configurations, something we don't want to do. You should rather deprecate the misspelled config setting and add a new one (just like what is done in the "binary" parser)...

srebhan · 2024-05-13T11:03:39Z

plugins/inputs/cloudwatch_metric_streams/cloudwatch_metric_streams.go

- APICompatability bool `toml:"api_compatability"`
+ APICompatibility bool `toml:"api_compatibility"`


We cannot do this change as this breaks existing configs! Please deprecate the old option and add a new one...

srebhan · 2024-05-13T11:05:03Z

plugins/inputs/fireboard/fireboard.go

- return "Celcius"
+ return "Celsius"


We cannot do this unfortunately as this will break existing queries because the metric changes...

srebhan · 2024-05-13T11:07:27Z

plugins/inputs/mongodb/mongodb_data.go

- "tcmalloc_pageheap_committed_bytes": "TCMallocPageheapComittedBytes",
+ "tcmalloc_pageheap_committed_bytes": "TCMallocPageheapCommittedBytes",


Hmmm are we sure that the type is not in the output of MongoDB stats? Otherwise this will break the plugin...

srebhan · 2024-05-13T11:08:24Z

plugins/inputs/mongodb/mongostat.go

- TCMallocPageheapComittedBytes int64
+ TCMallocPageheapCommittedBytes int64


Same here...

srebhan · 2024-05-13T11:09:08Z

plugins/inputs/openstack/openstack.go

- ServerDiagnotics bool `toml:"server_diagnotics"`
+ ServerDiagnostics bool `toml:"server_diagnostics"`


This will break existing configs. Please deprecate the old option and add a new one...

srebhan · 2024-05-13T11:09:56Z

plugins/inputs/ping/ping_windows.go

@@ -114,7 +114,7 @@ func processPingOutput(out string) (statistics, error) {
 statsLine = stat.FindStringSubmatch(line)
 }
 if statsLine != nil && aproxs == nil {
- aproxs = aprox.FindStringSubmatch(line)
+ aproxs = approx.FindStringSubmatch(line)


The array variable is also wrong, isn't it?

srebhan · 2024-05-13T11:12:53Z

plugins/parsers/binary/parser.go

- Endianess string `toml:"endianess" deprecated:"1.27.4;use 'endianness' instead"`
+ Endianness string `toml:"endianness" deprecated:"1.27.4;use 'endianness' instead"`


No! Actually this is to not break configs (i.e. what you should do for the other breaking config changes above), please leave this as-is!

srebhan · 2024-05-13T11:13:11Z

plugins/parsers/binary/parser.go

- if p.Endianess != "" && p.Endianness == "" {
- p.Endianness = p.Endianess
+ if p.Endianness != "" && p.Endianness == "" {
+ p.Endianness = p.Endianness


Same here. This is to be compatible with old configs!

szepeviktor · 2024-05-13T13:12:00Z

@srebhan I am sorry. Reverting manually takes hours.
I am using typos, a Rust software.

Now I am starting over again based on your comments.

szepeviktor · 2024-05-13T13:19:12Z

For the willing contributor: .typos.toml

[files]
extend-exclude = [
    ".git/",
    "go.mod",
    "go.sum",
    "CHANGELOG.md",
    "**/testcases/**",
    "**/testdata/**",

    "plugins/inputs/zfs/README.md",
]
ignore-hidden = false

[default]
extend-ignore-re = [
    "logical-ANDed",
    "\\$ecret-Passw0rd",
]

[default.extend-words]
"aproxs" = "approxs"

"aer" = "aer"
"bck" = "bck"
"iif" = "iif"
"oif" = "oif"
"pn" = "pn"
"rto" = "rto"
"siz" = "siz"
"wrk" = "wrk"
"endianess" = "endianess"
"mosquitto" = "mosquitto"
"splitted" = "splitted"

# Known typos
"celcius" = "celcius"
"compatability" = "compatability"
"diagnotics" = "diagnotics"
"uncorrect" = "uncorrect"

[default.extend-identifiers]
"TLS_RSA_WITH_3DES_EDE_CBC_SHA" = "TLS_RSA_WITH_3DES_EDE_CBC_SHA"
"TLS_ECDHE_RSA_WITH_3DES_EDE_CBC_SHA" = "TLS_ECDHE_RSA_WITH_3DES_EDE_CBC_SHA"
"Ip6InECT0Pkts" = "Ip6InECT0Pkts"
"Ip6InECT1Pkts" = "Ip6InECT1Pkts"
"icmpInParmProbs" = "icmpInParmProbs"
"IcmpInParmProbs" = "IcmpInParmProbs"
"icmpOutParmProbs" = "icmpOutParmProbs"
"IcmpOutParmProbs" = "IcmpOutParmProbs"
"idel_per_s" = "idel_per_s"
"network_idel_per_s" = "network_idel_per_s"
# Known typos
"TCMallocPageheapComittedBytes" = "TCMallocPageheapComittedBytes"

# Typos
##"Github" = "GitHub"

srebhan · 2024-05-14T13:30:37Z

@srebhan I am sorry. Reverting manually takes hours.
I am using typos, a Rust software.

Now I am starting over again based on your comments.

@szepeviktor why do you start over and why does it take hours? You just need to fix the few places I commented!?!?

srebhan · 2024-05-14T13:31:21Z

@powersj maybe we could use the software mentioned to add a GitHub action for checking spelling?

powersj · 2024-05-14T13:57:35Z

@powersj maybe we could use the software mentioned to add a GitHub action for checking spelling?

I like this idea, but maybe not typos, a rust-based tool. Maybe misspell?

szepeviktor · 2024-05-14T16:28:07Z

why does it take hours

Typos fixes typos. To revert a fix I have to search for each occurrence.

srebhan · 2024-05-14T17:29:27Z

@szepeviktor you could manually correct the few occurrences in the git branch. No need to rerun the tool... Am I missing something?

szepeviktor · 2024-05-14T17:33:34Z

The thing is typos work on the filesystem, not on git index.
So when you want to revert to "endianess" there are very many steps and they are error prone.

I've already redone everything.

srebhan · 2024-05-15T10:30:18Z

@szepeviktor let me be clear. You do have the present git-branch leading to this PR... Now why can't you fire-up an editor with the branch checked out and manually revert the changes in the files I mentioned without running typos again? I don't see why this is a lot of work, it's just opening an editor and changing eight lines back to what they were before!?!?!?

szepeviktor · 2024-05-15T11:04:07Z

When I work with typos the most of work is done by typos.
There is no "revert" function in typos, so I have to search git-diff-s to find all the lines where I have to revert a certain change.

szepeviktor · 2024-05-15T11:08:34Z

BTW I do not write source code daily. I use an editor built into Midnight Commander.

powersj changed the title ~~Fix typos~~ chore: Fix typos throughout codebase May 10, 2024

telegraf-tiger bot added the chore label May 10, 2024

srebhan requested changes May 13, 2024

View reviewed changes

srebhan self-assigned this May 13, 2024

Fix typos

078b960

szepeviktor force-pushed the typos branch from 74dc254 to 078b960 Compare May 13, 2024 13:12

Revert prometheus

5668af4

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

chore: Fix typos throughout codebase #15338

chore: Fix typos throughout codebase #15338

szepeviktor commented May 10, 2024 •

edited

telegraf-tiger bot commented May 10, 2024

powersj commented May 10, 2024

szepeviktor commented May 10, 2024

szepeviktor commented May 10, 2024

powersj commented May 10, 2024

powersj commented May 10, 2024

srebhan left a comment

srebhan May 13, 2024

srebhan May 13, 2024

srebhan May 13, 2024

srebhan May 13, 2024

srebhan May 13, 2024

srebhan May 13, 2024

srebhan May 13, 2024

srebhan May 13, 2024

szepeviktor commented May 13, 2024 •

edited

szepeviktor commented May 13, 2024 •

edited

srebhan commented May 14, 2024

srebhan commented May 14, 2024

powersj commented May 14, 2024

szepeviktor commented May 14, 2024

srebhan commented May 14, 2024

szepeviktor commented May 14, 2024 •

edited

srebhan commented May 15, 2024 •

edited

szepeviktor commented May 15, 2024 •

edited

szepeviktor commented May 15, 2024

		APICompatability bool `toml:"api_compatability"`
		APICompatibility bool `toml:"api_compatibility"`

		"tcmalloc_pageheap_committed_bytes": "TCMallocPageheapComittedBytes",
		"tcmalloc_pageheap_committed_bytes": "TCMallocPageheapCommittedBytes",

		TCMallocPageheapComittedBytes int64
		TCMallocPageheapCommittedBytes int64

		ServerDiagnotics bool `toml:"server_diagnotics"`
		ServerDiagnostics bool `toml:"server_diagnostics"`

		Endianess string `toml:"endianess" deprecated:"1.27.4;use 'endianness' instead"`
		Endianness string `toml:"endianness" deprecated:"1.27.4;use 'endianness' instead"`

chore: Fix typos throughout codebase #15338

Are you sure you want to change the base?

chore: Fix typos throughout codebase #15338

Conversation

szepeviktor commented May 10, 2024 • edited

Summary

Checklist

telegraf-tiger bot commented May 10, 2024

powersj commented May 10, 2024

szepeviktor commented May 10, 2024

szepeviktor commented May 10, 2024

powersj commented May 10, 2024

powersj commented May 10, 2024

srebhan left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

szepeviktor commented May 13, 2024 • edited

szepeviktor commented May 13, 2024 • edited

srebhan commented May 14, 2024

srebhan commented May 14, 2024

powersj commented May 14, 2024

szepeviktor commented May 14, 2024

srebhan commented May 14, 2024

szepeviktor commented May 14, 2024 • edited

srebhan commented May 15, 2024 • edited

szepeviktor commented May 15, 2024 • edited

szepeviktor commented May 15, 2024

szepeviktor commented May 10, 2024 •

edited

szepeviktor commented May 13, 2024 •

edited

szepeviktor commented May 13, 2024 •

edited

szepeviktor commented May 14, 2024 •

edited

srebhan commented May 15, 2024 •

edited

szepeviktor commented May 15, 2024 •

edited