mirror of
https://github.com/Nanaloveyuki/BitLogger.git
synced 2026-07-24 00:42:18 +00:00
Nanaloveyuki
78 lines
2.2 KiB
Markdown
78 lines
2.2 KiB
Markdown
---
|
|
name: runtime-sink-file-rotation-failures
|
|
group: api
|
|
category: runtime
|
|
update-time: 20260707
|
|
description: Read the number of rotation failures recorded by a file-backed RuntimeSink.
|
|
key-word:
|
|
- runtime
|
|
- sink
|
|
- file
|
|
- public
|
|
---
|
|
|
|
## Runtime-sink-file-rotation-failures
|
|
|
|
Read the number of file-rotation attempts whose critical file steps failed in a file-backed `RuntimeSink`.
|
|
|
|
### Interface
|
|
|
|
```moonbit
|
|
pub fn RuntimeSink::file_rotation_failures(self : RuntimeSink) -> Int {
|
|
```
|
|
|
|
#### input
|
|
|
|
- `self : RuntimeSink` - Runtime sink whose rotation-failure counter should be inspected.
|
|
|
|
#### output
|
|
|
|
- `Int` - Number of recorded rotation failures.
|
|
|
|
### Explanation
|
|
|
|
Detailed rules explaining key parameters and behaviors
|
|
|
|
- Plain `File` runtime variants report the wrapped `FileSink` rotation-failure count.
|
|
- `QueuedFile` runtime variants forward the metric from the wrapped inner `FileSink`.
|
|
- Non-file runtime variants return `0`.
|
|
- For file-backed variants, the counter covers incomplete rotations caused by critical remove/rename/reopen failures, not merely policy changes or missing optional backup slots.
|
|
- The counter is cumulative until `file_reset_failure_counters()` clears it.
|
|
|
|
### How to Use
|
|
|
|
Here are some specific examples provided.
|
|
|
|
#### When Need Rotation-specific Diagnostics
|
|
|
|
When support output should reveal whether rotation is failing:
|
|
```moonbit
|
|
let count = sink.file_rotation_failures()
|
|
```
|
|
|
|
In this example, the runtime sink exposes whether direct file rotation stopped completing its critical steps.
|
|
|
|
#### When Validate Runtime Rotation Tuning
|
|
|
|
When changed rotation settings should be checked in operation:
|
|
```moonbit
|
|
ignore(sink.file_rotation_failures())
|
|
```
|
|
|
|
In this example, callers can observe whether runtime rotation changes introduced incomplete rotations.
|
|
|
|
### Error Case
|
|
|
|
e.g.:
|
|
- If the runtime sink is not file-backed, the method returns `0`.
|
|
|
|
- If callers need both rotation config and failure metrics, they should combine this helper with `file_rotation_config()` or `file_state()`.
|
|
|
|
- This counter does not expose which low-level step failed inside the rotation chain.
|
|
|
|
### Notes
|
|
|
|
1. Use this helper when diagnosing incomplete direct runtime file rotations.
|
|
|
|
2. It is especially relevant when runtime rotation policy can change after startup.
|