Skip to content

Commit

Permalink
Merge pull request #732 from RizaFarheen/main
Browse files Browse the repository at this point in the history
broken link fix
  • Loading branch information
RizaFarheen committed Jul 25, 2024
2 parents 559d575 + 8bf30b4 commit c6209cf
Show file tree
Hide file tree
Showing 2 changed files with 7 additions and 11 deletions.
2 changes: 1 addition & 1 deletion docs/developer-guides/metrics-and-observability.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ The server publishes the following metrics. You can use these metrics to configu
| ------- | -------------------- | ------- | ---- |
| Workflow Latencies (Name and Percentile)<br/><br/>**workflow_completed_seconds** | <p align="center"><img src="/content/img/workflow-completed-seconds.png" alt="Workflow Latencies" width="100%" height="auto"></img></p> | Timer indicating the time taken for completing the workflows. | workflowName, quantile |
| Workflow completion/sec<br/><br/>**workflow_completed_seconds_count** | <p align="center"><img src="/content/img/workflow-completed-seconds-count.png" alt="Workflow completion/sec" width="100%" height="auto"></img></p> | Counter indicating the number of workflows completed per second. | workflowName |
| Workflow failures/sec<br/><br/>**workflow_completed_seconds_count** | <p align="center"><img src="/content/img/workflow-completed-seconds-count-1.png" alt="Workflow failures/sec" width="100%" height="auto"></img></p> | Counter indicating the number of workflows failed per second. | workflowName |
| Workflow failures/sec<br/><br/>**workflow_completed_seconds_count** (Ensure to add the filter "FAILED" to get the failed list) | <p align="center"><img src="/content/img/workflow-completed-seconds-count-1.png" alt="Workflow failures/sec" width="100%" height="auto"></img></p> | Counter indicating the number of workflows failed per second. | workflowName |
| No of workflows currently Running<br/><br/>**workflow_running** | <p align="center"><img src="/content/img/workflow-running.png" alt="No of workflows currently running" width="100%" height="auto"></img></p> | Gauge for the number of running workflows. | workflowName |
| Workflow Start Rate/sec<br/><br/>**workflow_start_request_seconds_count** | <p align="center"><img src="/content/img/workflow-start-request-seconds-count.png" alt="Workflow Start Rate/sec" width="100%" height="auto"></img></p> | Counter for no. of workflows started. | workflowName |
| Total no. of workflows started in the time period<br/><br/>**workflow_start_request_seconds_count** | <p align="center"><img src="/content/img/workflow-start-request-seconds-count-1.png" alt="Total no. of workflows started in the time period" width="100%" height="auto"></img></p> | Counter for no. of workflows started in the time period. | workflowName |
Expand Down
16 changes: 6 additions & 10 deletions docs/sdks/java.md
Original file line number Diff line number Diff line change
Expand Up @@ -114,7 +114,7 @@ http://localhost:8080/api/metadata/workflow -d @workflow.json
```

:::note
To use the Conductor API, the Conductor server must be up and running (see [Running over Conductor standalone (installed locally)](#running-workflows-on-conductor-standalone-installed-locally))
To use the Conductor API, the Conductor server must be up and running (see [Running over Conductor standalone (installed locally)](/content/sdks/java#running-workflows-on-conductor-standalone-installed-locally))
:::

### Step 2: Write Worker
Expand Down Expand Up @@ -215,7 +215,7 @@ public class Main {
}
```

Add the [ApiUtil.java](https://github.com/orkes-io/orkes-conductor-client/blob/main/examples/java/io/orkes/conductor/sdk/ApiUtil.java) file to set the environment variables.
Add the [ApiUtil.java](https://github.com/orkes-io/orkes-conductor-client/blob/main/examples/java/io/orkes/conductor/sdk/examples/ApiUtil.java) file to set the environment variables.

## Running Workflows on Conductor Standalone (Installed Locally)

Expand Down Expand Up @@ -552,11 +552,11 @@ public class ConductorWorkers {
}
```

See [DynamicWorkflow](https://github.com/orkes-io/orkes-conductor-client/tree/main/examples/java/io/orkes/conductor/sdk/DynamicWorkflow) for a fully functional example.
See [DynamicWorkflow](https://github.com/orkes-io/orkes-conductor-client/tree/main/examples/java/io/orkes/conductor/sdk/examples/dynamicworkflow) for a fully functional example.

#### Kitchen-Sink Workflow

For a more complex workflow example with all the supported features, see [KitchenSink.java](https://github.com/orkes-io/orkes-conductor-client/blob/main/examples/java/io/orkes/conductor/sdk/KitchenSink.java).
For a more complex workflow example with all the supported features, see [KitchenSink.java](https://github.com/orkes-io/orkes-conductor-client/blob/main/examples/java/io/orkes/conductor/sdk/examples/KitchenSink.java)

### Executing Workflows

Expand Down Expand Up @@ -589,7 +589,7 @@ Workflow workflowRun = workflowExecution.get(10, TimeUnit.SECONDS);
### Managing Workflow Executions

:::note
See [WorkflowOps.java](https://github.com/orkes-io/orkes-conductor-client/blob/main/examples/java/io/orkes/conductor/sdk/WorkflowOps.java) for a fully working application that demonstrates working with the workflow executions and sending signals to the workflow to manage its state.
See [WorkflowOps.java](https://github.com/orkes-io/orkes-conductor-client/blob/main/examples/java/io/orkes/conductor/sdk/examples/WorkflowOps.java) for a fully working application that demonstrates working with the workflow executions and sending signals to the workflow to manage its state.
:::

Workflows represent the application state. With Conductor, you can query the workflow execution state anytime during its lifecycle. You can also send signals to the workflow that determines the outcome of the workflow state.
Expand Down Expand Up @@ -788,7 +788,7 @@ public class TaskDefinitionTest {
POST /api/metadata/taskdef -d @task_def.json
```

See [TaskConfigure.java](https://github.com/orkes-io/orkes-conductor-client/blob/main/examples/java/io/orkes/conductor/sdk/TaskConfigure.java) for a detailed working app.
See [TaskConfigure.java](https://github.com/orkes-io/orkes-conductor-client/blob/main/examples/java/io/orkes/conductor/sdk/examples/TaskConfigure.java) for a detailed working app.

## Using Conductor in Your Application

Expand Down Expand Up @@ -868,10 +868,6 @@ For Maven-based projects, modify the `pom.xml` file in the project directory by
Workflow workers are your regular Java functions and can be tested with any available testing framework.
:::

#### Example Unit Testing Application

See [WorkflowTest.java](https://github.com/orkes-io/orkes-conductor-client/blob/main/examples/java/io/orkes/conductor/sdk/WorkflowTest.java) for a fully functional example of how to test a moderately complex workflow with branches.

### Workflow Deployments Using CI/CD

:::tip
Expand Down

0 comments on commit c6209cf

Please sign in to comment.