outputs: azure_logs_ingestion: Update time_generated description

[hashtagchris]

The time_generated config setting influences the time format, not the addition of a timestamp field as previously documented.

Reference: https://github.com/fluent/fluent-bit/blob/a1d9c2a9a637bba1d8918c6c7a49b8279fd6df0a/plugins/out_azure_logs_ingestion/azure_logs_ingestion.c#L107-L131

Summary by CodeRabbit

• Documentation
  • Clarified the time_generated parameter: when enabled, timestamps under the configured key are ISO 8601 strings; when disabled, timestamps are floating-point seconds since the Unix epoch.
  • Reworded description to emphasize formatting behavior; default behavior and controls remain unchanged.

[coderabbitai]

Note

Reviews paused

It looks like this branch is under active development. To avoid overwhelming you with review comments due to an influx of new commits, CodeRabbit has automatically paused this review. You can configure this behavior by changing the reviews.auto_review.auto_pause_after_reviewed_commits setting.

Use the following commands to manage reviews:

• @coderabbitai resume to resume automatic reviews.
• @coderabbitai review to trigger a single review.

Use the checkboxes below for quick actions:

• ▶️ Resume reviews
• 🔍 Trigger review

📝 Walkthrough

Walkthrough

Updated documentation for the time_generated parameter in Azure Logs Ingestion: when enabled the timestamp written under time_key is an ISO 8601 string; when disabled the timestamp is a floating‑point number of seconds since the Unix epoch.

Changes

Cohort / File(s)	Summary
Documentation Update pipeline/outputs/azure_logs_ingestion.md	Reworded time_generated description to specify timestamp format: ISO 8601 string under time_key when enabled; floating-point seconds-since-epoch when disabled. No behavioral or default changes.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~2 minutes

Possibly related PRs

• docs: outputs: azure_logs_ingestion: fix defaults, sort table, update key casing #2413 — Related edit to azure_logs_ingestion docs regarding time_generated defaults and key casing.

Suggested labels

5.0

Suggested reviewers

• cosmo0920

Poem

🐇 I hopped through docs with nimble paws,
I nudged the time into tidy laws,
ISO light when toggles sing,
Floats return on quieter wing,
A rabbit fixed a single clause.

🚥 Pre-merge checks | ✅ 3

✅ Passed checks (3 passed)

Check name	Status	Explanation
Description Check	✅ Passed	Check skipped - CodeRabbit’s high-level summary is enabled.
Title check	✅ Passed	The title accurately and specifically describes the main change: updating the time_generated description in the azure_logs_ingestion output documentation.
Docstring Coverage	✅ Passed	No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

_{✏️ Tip: You can configure your own custom pre-merge checks in the settings.}

✨ Finishing Touches

🧪 Generate unit tests (beta)

• Create PR with unit tests
• Post copyable unit tests in a comment

📝 Coding Plan

• Generate coding plan for human review comments

---

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

_{Comment @coderabbitai help to get the list of available commands and usage tips.}

[coderabbitai]

Actionable comments posted: 1

🤖 Prompt for all review comments with AI agents

Verify each finding against the current code and only fix it if needed.

Inline comments:
In `@pipeline/outputs/azure_logs_ingestion.md`:
- Line 35: Update the `time_generated` description to clarify the floating-point
representation: state that when disabled the timestamp is a floating‑point
number representing seconds since the Unix epoch (i.e., Unix time as fractional
seconds), and ensure the wording references `time_key` so it reads: "If
disabled, it is a floating-point number of seconds since the Unix epoch." This
aligns the `time_generated` explanation with other plugin docs (GELF, Plot) and
removes ambiguity about the reference point.

---

ℹ️ Review info

⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: f739d277-ee95-4aa1-a860-810c159ec0b2

📥 Commits

Reviewing files that changed from the base of the PR and between 1481ad4 and 226257d.

📒 Files selected for processing (1)

• pipeline/outputs/azure_logs_ingestion.md

[eschabell]

@hashtagchris thanks for the docs PR, as you can see need to fix the lint errors:

Raw Output:
  {"message": "[FluentBit.Contractions] Feel free to use 'it's' instead of 'it is'.", "location": {"path": "pipeline/outputs/azure_logs_ingestion.md", "range": {"start": {"line": 35, "column": 133}}}, "severity": "INFO"}
Error: Vale and reviewdog exited with status code: 1

I'll review once all errors are addressed.

[coderabbitai]

Actionable comments posted: 1

🤖 Prompt for all review comments with AI agents

Verify each finding against the current code and only fix it if needed.

Inline comments:
In `@pipeline/outputs/azure_logs_ingestion.md`:
- Line 35: The sentence describing `time_generated` uses the contraction "it's";
update the Markdown to expand the contraction to "it is" so the line reads
"...If disabled, it is a floating-point number representing seconds since Unix
epoch." Locate the table row referencing `time_generated` and `time_key` and
replace "it's" with "it is" to satisfy the Vale lint rule.

---

ℹ️ Review info

⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: 031c5df6-84d2-47cf-9cc6-23a56f4077e3

📥 Commits

Reviewing files that changed from the base of the PR and between 084153e and 9cfef34.

📒 Files selected for processing (1)

• pipeline/outputs/azure_logs_ingestion.md

[coderabbitai]

⚠️ Potential issue | 🟡 Minor

Fix the contraction to resolve Vale lint error.

The Vale linter flagged the contraction "it's" on this line. Technical documentation should avoid contractions for formality and clarity.

📝 Proposed fix to expand the contraction

-| `time_generated` | Optional. If enabled, the timestamp appended under `time_key` is formatted as an ISO 8601 string. If disabled, it's a floating-point number representing seconds since Unix epoch. | `true` |
+| `time_generated` | Optional. If enabled, the timestamp appended under `time_key` is formatted as an ISO 8601 string. If disabled, it is a floating-point number representing seconds since Unix epoch. | `true` |

📝 Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change

	| `time_generated` | Optional. If enabled, the timestamp appended under `time_key` is formatted as an ISO 8601 string. If disabled, it's a floating-point number representing seconds since Unix epoch. | `true` |
	| `time_generated` | Optional. If enabled, the timestamp appended under `time_key` is formatted as an ISO 8601 string. If disabled, it is a floating-point number representing seconds since Unix epoch. | `true` |

🤖 Prompt for AI Agents

Verify each finding against the current code and only fix it if needed.

In `@pipeline/outputs/azure_logs_ingestion.md` at line 35, The sentence describing
`time_generated` uses the contraction "it's"; update the Markdown to expand the
contraction to "it is" so the line reads "...If disabled, it is a floating-point
number representing seconds since Unix epoch." Locate the table row referencing
`time_generated` and `time_key` and replace "it's" with "it is" to satisfy the
Vale lint rule.

[eschabell]

@hashtagchris sorry my friend, but there is now conflicts due to ongoing updates that hit this plugin doc as we prep for coming release. Can you rebase to pull the changes into your branch, should solve it.

[hashtagchris]

@eschabell Rebased. Thanks for the speedy review, and all you do to keep the docs high-quality!