Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix: update influxdb input schema documentation #10029

Merged
merged 2 commits into from
Nov 1, 2021
Merged

Conversation

sanderson
Copy link
Contributor

  • Updated associated README.md.
  • Wrote appropriate unit tests. (N/A)
  • Pull request title or commits are in conventional commit format

Closes influxdata/DAR#232

Updated the metrics and descriptions returned by the InfluxDB input plugin.

@sanderson sanderson requested review from sjwang90, noramullen1 and a team October 29, 2021 19:50
@telegraf-tiger telegraf-tiger bot added the fix pr to fix corresponding bug label Oct 29, 2021
@powersj powersj added the ready for final review This pull request has been reviewed and/or tested by multiple users and is ready for a final review. label Oct 29, 2021
Comment on lines -56 to -81
- heap_inuse: The number of bytes in in-use spans.
- heap_released: The number of bytes of physical memory returned to the OS.
- mspan_inuse: The number of bytes in in-use mspans.
- total_alloc: The cumulative bytes allocated for heap objects.
- sys: The total number of bytes of memory obtained from the OS. Measures the virtual address space reserved by the Go runtime for the heap, stacks, and other internal data structures.
- mallocs: The total number of heap objects allocated. (The total number of live objects are frees.)
- frees: The cumulative number of freed (live) heap objects.
- heap_idle: The number of bytes of idle heap objects.
- pause_total_ns: The total time garbage collection cycles are paused in nanoseconds.
- lookups: The number of pointer lookups performed by the runtime. Primarily useful for debugging runtime internals.
- heap_sys: The number of bytes of heap memory obtained from the OS. Measures the amount of virtual address space reserved for the heap.
- mcache_sys: The bytes of memory obtained from the OS for mcache structures.
- next_gc: The target heap size of the next garbage collection cycle.
- gc_cpu_fraction: The fraction of CPU time used by the garbage collection cycle.
- other_sys: The number of bytes of memory used other than heap_sys, stacks_sys, mspan_sys, mcache_sys, buckhash_sys, and gc_sys.
- alloc: The currently allocated number of bytes of heap objects.
- stack_inuse: The number of bytes in in-use stacks.
- stack_sys: The total number of bytes of memory obtained from the stack in use.
- buck_hash_sys: The bytes of memory in profiling bucket hash tables.
- gc_sys: The bytes of memory in garbage collection metadata.
- num_gc: The number of completed garbage collection cycles.
- heap_alloc: The size, in bytes, of all heap objects.
- heap_objects: The number of allocated heap objects.
- mspan_sys: The bytes of memory obtained from the OS for mspan.
- mcache_inuse: The bytes of allocated mcache structures.
- last_gc: Time the last garbage collection finished, as nanoseconds since 1970 (the UNIX epoch).
Copy link
Contributor

Choose a reason for hiding this comment

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

These were snake_case before but switched to camelCase. Was this a doc error that is being corrected or are they supposed to be snake_case?

Copy link
Contributor Author

@sanderson sanderson Nov 1, 2021

Choose a reason for hiding this comment

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

@reimda, I updated these to the most recent version of InfluxDB 1.x (1.8). It could be that they were snake_case in previous versions of InfluxDB when this input was originally developed, but they have since changed to camelCase.

@reimda reimda merged commit 934db67 into master Nov 1, 2021
@reimda reimda deleted the update-influxdb-input branch November 1, 2021 19:45
powersj pushed a commit that referenced this pull request Nov 17, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
fix pr to fix corresponding bug ready for final review This pull request has been reviewed and/or tested by multiple users and is ready for a final review.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants