Skip to content

Commit 261c8c5

Browse files
KielekKielek
committed
md lint
1 parent 4b95bb7 commit 261c8c5

File tree

1 file changed

+59
-59
lines changed
  • src/OpenTelemetry.Instrumentation.Hangfire

1 file changed

+59
-59
lines changed

‎src/OpenTelemetry.Instrumentation.Hangfire/README.md‎

Lines changed: 59 additions & 59 deletions
Original file line numberDiff line numberDiff line change
@@ -289,12 +289,12 @@ The number of task executions which have been initiated.
289289
290290
**Attributes:**
291291

292-
| Attribute | Type | Description | Requirement Level | Values |
293-
| ----------------------------- | ------ | --------------------------------------------- | ------------------------ | ----------------------- |
294-
| `workflow.task.name` | string | Name of the task (Hangfire job method) | Required | e.g., `MyJob.Execute` |
295-
| `workflow.execution.result` | string | The result of executing the task | Required | `success`, `failure` |
296-
| `workflow.platform.name` | string | The workflow platform being used | Recommended | `hangfire` |
297-
| `error.type` | string | The type of error that occurred | Conditionally Required[1] | Exception type name |
292+
| Attribute | Type | Description | Requirement Level | Values |
293+
| --------------------------- | ------ | -------------------------------------- | ------------------------- | ----------------------- |
294+
| `workflow.task.name` | string | Name of the task (Hangfire job method) | Required | e.g., `MyJob.Execute` |
295+
| `workflow.execution.result` | string | The result of executing the task | Required | `success`, `failure` |
296+
| `workflow.platform.name` | string | The workflow platform being used | Recommended | `hangfire` |
297+
| `error.type` | string | The type of error that occurred | Conditionally Required[1] | Exception type name |
298298

299299
[1]: Required if and only if the task execution failed.
300300

@@ -319,23 +319,23 @@ for different execution phases:
319319
320320
**Attributes:**
321321

322-
| Attribute | Type | Description | Requirement Level | Values |
323-
| ----------------------------- | ------ | --------------------------------------------- | ------------------------ | ----------------------- |
324-
| `workflow.task.name` | string | Name of the task (Hangfire job method) | Required | e.g., `MyJob.Execute` |
325-
| `workflow.execution.result` | string | The result of executing the task | Required | `success`, `failure` |
326-
| `workflow.execution.state` | string | The execution phase being measured | Required | `pending`, `executing` |
327-
| `workflow.platform.name` | string | The workflow platform being used | Recommended | `hangfire` |
328-
| `error.type` | string | The type of error that occurred | Conditionally Required[1] | Exception type name |
322+
| Attribute | Type | Description | Requirement Level | Values |
323+
| --------------------------- | ------ | -------------------------------------- | ------------------------- | ---------------------- |
324+
| `workflow.task.name` | string | Name of the task (Hangfire job method) | Required | e.g., `MyJob.Execute` |
325+
| `workflow.execution.result` | string | The result of executing the task | Required | `success`, `failure` |
326+
| `workflow.execution.state` | string | The execution phase being measured | Required | `pending`, `executing` |
327+
| `workflow.platform.name` | string | The workflow platform being used | Recommended | `hangfire` |
328+
| `error.type` | string | The type of error that occurred | Conditionally Required[1] | Exception type name |
329329

330330
[1]: Required if and only if the task execution failed.
331331

332332
#### workflow.execution.status
333333

334334
The number of actively running tasks grouped by task and the current state.
335335

336-
| Units | Instrument Type | Value Type |
337-
|----------------|------------------|------------|
338-
| `{executions}` | UpDownCounter | `Int64` |
336+
| Units | Instrument Type | Value Type |
337+
| -------------- | --------------- | ---------- |
338+
| `{executions}` | UpDownCounter | `Int64` |
339339

340340
> [!NOTE]
341341
> This metric tracks the current state of job executions. When a job
@@ -344,24 +344,24 @@ The number of actively running tasks grouped by task and the current state.
344344
345345
**Attributes:**
346346

347-
| Attribute | Type | Description | Requirement Level | Values |
348-
|-------------------------------|--------|-----------------------------------------------|--------------------------|-------------------------------------------|
349-
| `workflow.task.name` | string | Name of the task (Hangfire job method) | Required | e.g., `MyJob.Execute` |
350-
| `workflow.execution.state` | string | Current state of the execution | Required | `pending`, `executing`, `completed` |
351-
| `workflow.platform.name` | string | The workflow platform being used | Recommended | `hangfire` |
352-
| `error.type` | string | The type of error that occurred | Conditionally Required[1] | Exception type name |
347+
| Attribute | Type | Description | Requirement Level | Values |
348+
| -------------------------- | ------ | -------------------------------------- | ------------------------- | ----------------------------------- |
349+
| `workflow.task.name` | string | Name of the task (Hangfire job method) | Required | e.g., `MyJob.Execute` |
350+
| `workflow.execution.state` | string | Current state of the execution | Required | `pending`, `executing`, `completed` |
351+
| `workflow.platform.name` | string | The workflow platform being used | Recommended | `hangfire` |
352+
| `error.type` | string | The type of error that occurred | Conditionally Required[1] | Exception type name |
353353

354354
[1]: Required if and only if the task execution failed.
355355

356356
**Hangfire State Mapping:**
357357

358358
Hangfire job states are mapped to workflow semantic convention states as follows:
359359

360-
| Hangfire State | Workflow State |
361-
| ---------------------------------- | -------------- |
362-
| Scheduled, Enqueued, Awaiting | `pending` |
363-
| Processing | `executing` |
364-
| Succeeded, Failed, Deleted | `completed` |
360+
| Hangfire State | Workflow State |
361+
| ----------------------------- | -------------- |
362+
| Scheduled, Enqueued, Awaiting | `pending` |
363+
| Processing | `executing` |
364+
| Succeeded, Failed, Deleted | `completed` |
365365

366366
#### workflow.execution.errors
367367

@@ -373,40 +373,40 @@ The number of errors encountered in task executions.
373373

374374
**Attributes:**
375375

376-
| Attribute | Type | Description | Requirement Level | Values |
377-
|-------------------------------|--------|-----------------------------------------------|-------------------|-------------------------|
378-
| `error.type` | string | The type of error that occurred | Required | Exception type name |
379-
| `workflow.task.name` | string | Name of the task (Hangfire job method) | Required | e.g., `MyJob.Execute` |
380-
| `workflow.platform.name` | string | The workflow platform being used | Recommended | `hangfire` |
376+
| Attribute | Type | Description | Requirement Level | Values |
377+
| ------------------------ | ------ | -------------------------------------- | ----------------- | --------------------- |
378+
| `error.type` | string | The type of error that occurred | Required | Exception type name |
379+
| `workflow.task.name` | string | Name of the task (Hangfire job method) | Required | e.g., `MyJob.Execute` |
380+
| `workflow.platform.name` | string | The workflow platform being used | Recommended | `hangfire` |
381381

382382
#### workflow.outcome
383383

384384
The number of workflow instances which have been initiated. In Hangfire, this tracks
385385
individual job completions.
386386

387-
| Units | Instrument Type | Value Type |
388-
| -------------- | --------------- | ---------- |
389-
| `{workflows}` | Counter | `Int64` |
387+
| Units | Instrument Type | Value Type |
388+
| ------------- | --------------- | ---------- |
389+
| `{workflows}` | Counter | `Int64` |
390390

391391
**Attributes:**
392392

393-
| Attribute | Type | Description | Requirement Level | Values |
394-
| ----------------------------- | ------ | --------------------------------------------- | ------------------------ | ----------------------- |
395-
| `workflow.definition.name` | string | Name of the workflow (Hangfire job method) | Required | e.g., `MyJob.Execute` |
396-
| `workflow.result` | string | The result of the workflow | Required | `success`, `failure` |
397-
| `workflow.trigger.type` | string | Type of trigger that initiated the workflow | Required | `api`, `cron`, `schedule` |
398-
| `workflow.platform.name` | string | The workflow platform being used | Recommended | `hangfire` |
399-
| `error.type` | string | The type of error that occurred | Conditionally Required[1] | Exception type name |
393+
| Attribute | Type | Description | Requirement Level | Values |
394+
| -------------------------- | ------ | ------------------------------------------- | ------------------------- | ------------------------- |
395+
| `workflow.definition.name` | string | Name of the workflow (Hangfire job method) | Required | e.g., `MyJob.Execute` |
396+
| `workflow.result` | string | The result of the workflow | Required | `success`, `failure` |
397+
| `workflow.trigger.type` | string | Type of trigger that initiated the workflow | Required | `api`, `cron`, `schedule` |
398+
| `workflow.platform.name` | string | The workflow platform being used | Recommended | `hangfire` |
399+
| `error.type` | string | The type of error that occurred | Conditionally Required[1] | Exception type name |
400400

401401
[1]: Required if and only if the workflow execution failed.
402402

403403
#### workflow.status
404404

405405
The number of actively running workflows grouped by definition and the current state.
406406

407-
| Units | Instrument Type | Value Type |
408-
| -------------- | ---------------- | ---------- |
409-
| `{workflows}` | UpDownCounter | `Int64` |
407+
| Units | Instrument Type | Value Type |
408+
| ------------- | --------------- | ---------- |
409+
| `{workflows}` | UpDownCounter | `Int64` |
410410

411411
> [!NOTE]
412412
> This metric tracks the workflow lifecycle including jobs that haven't
@@ -416,27 +416,27 @@ The number of actively running workflows grouped by definition and the current s
416416
417417
**Attributes:**
418418

419-
| Attribute | Type | Description | Requirement Level | Values |
420-
| ----------------------------- | ------ | --------------------------------------------- | ------------------------ | ----------------------------------------- |
421-
| `workflow.definition.name` | string | Name of the workflow (Hangfire job method) | Required | e.g., `MyJob.Execute` |
422-
| `workflow.state` | string | Current state of the workflow | Required | `pending`, `executing`, `completed` |
423-
| `workflow.trigger.type` | string | Type of trigger that initiated the workflow | Required | `api`, `cron`, `schedule` |
424-
| `workflow.platform.name` | string | The workflow platform being used | Recommended | `hangfire` |
425-
| `error.type` | string | The type of error that occurred | Conditionally Required[1] | Exception type name |
419+
| Attribute | Type | Description | Requirement Level | Values |
420+
| -------------------------- | ------ | ------------------------------------------- | ------------------------- | ----------------------------------- |
421+
| `workflow.definition.name` | string | Name of the workflow (Hangfire job method) | Required | e.g., `MyJob.Execute` |
422+
| `workflow.state` | string | Current state of the workflow | Required | `pending`, `executing`, `completed` |
423+
| `workflow.trigger.type` | string | Type of trigger that initiated the workflow | Required | `api`, `cron`, `schedule` |
424+
| `workflow.platform.name` | string | The workflow platform being used | Recommended | `hangfire` |
425+
| `error.type` | string | The type of error that occurred | Conditionally Required[1] | Exception type name |
426426

427427
[1]: Required if and only if the workflow execution failed.
428428

429429
**Hangfire State Mapping:**
430430

431431
Hangfire job states are mapped to workflow semantic convention states as follows:
432432

433-
| Hangfire State | Workflow State | Workflow Trigger Type |
434-
| ---------------------------------- | -------------- | ------------------------------- |
435-
| Scheduled | `pending` | `schedule` |
436-
| Enqueued, Awaiting (from cron) | `pending` | `cron` |
437-
| Enqueued, Awaiting (fire-and-forget)| `pending` | `api` |
438-
| Processing | `executing` | (inherited from previous state) |
439-
| Succeeded, Failed, Deleted | `completed` | (inherited from previous state) |
433+
| Hangfire State | Workflow State | Workflow Trigger Type |
434+
| ------------------------------------ | -------------- | ------------------------------- |
435+
| Scheduled | `pending` | `schedule` |
436+
| Enqueued, Awaiting (from cron) | `pending` | `cron` |
437+
| Enqueued, Awaiting (fire-and-forget) | `pending` | `api` |
438+
| Processing | `executing` | (inherited from previous state) |
439+
| Succeeded, Failed, Deleted | `completed` | (inherited from previous state) |
440440

441441
> [!IMPORTANT]
442442
> **Difference between `workflow.status` and `workflow.execution.status`:**

0 commit comments

Comments
 (0)