Skip to content

Commit d100608

Browse files
authored
Move Operations/ files to Infrastructure/ (#494)
Move 6 files from Operations/ to Infrastructure/, including renaming Development-vs-Production.md to Application-Development-vs-Production.md. Merge Operations section into Infrastructure in Home.md. Remove Operations namespace from build scripts. Update .markdownlint-cli2.jsonc exclusion path.
1 parent 5298b21 commit d100608

39 files changed

Lines changed: 72 additions & 77 deletions

.markdownlint-cli2.jsonc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66
"!Librdkafka/Statistics.md",
77
"!Librdkafka/Configuration.md",
88
"!Development/Karafka-Integration-Tests-Catalog.md",
9-
"!Operations/Instrumentation-Events.md",
9+
"!Infrastructure/Instrumentation-Events.md",
1010
"!WaterDrop/Instrumentation-Events.md",
1111
"!Changelog/*.md",
1212
"!Pro/License-Comm.md",

Advanced/Assignments-Tracking.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -32,6 +32,6 @@ end
3232

3333
## See Also
3434

35-
- [Monitoring and Logging](Operations-Monitoring-and-Logging) - Track consumer assignments and partition distribution
35+
- [Monitoring and Logging](Infrastructure-Monitoring-and-Logging) - Track consumer assignments and partition distribution
3636
- [Web UI Features](Web-UI-Features) - Visualize partition assignments in the Web UI
3737
- [Concurrency and Multithreading](Concurrency-and-Multithreading) - Understanding thread safety with partition assignments

Advanced/Auto-reload-of-code-changes-in-development.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -27,5 +27,5 @@ Keep in mind, though, that there are a couple of limitations to it:
2727

2828
## See Also
2929

30-
- [Development vs Production](Operations-Development-vs-Production) - Best practices for different environments
30+
- [Development vs Production](Infrastructure-Application-Development-vs-Production) - Best practices for different environments
3131
- [Getting Started](Basics-Getting-Started) - Initial setup and configuration basics

Advanced/Broker-Failures-and-Fault-Tolerance.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -446,5 +446,5 @@ Connection refused errors during broker maintenance indicate the system is worki
446446
- [Error Handling and Back Off Policy](Consumer-Groups-Error-Handling-and-Back-Off-Policy) - Configure retry strategies and backoff policies for consumer errors
447447
- [Dead Letter Queue](Dead-Letter-Queue) - Handle persistent failures by routing problematic messages to DLQ
448448
- [Enhanced Dead Letter Queue](Pro-Enhanced-Dead-Letter-Queue) - Advanced DLQ features for complex failure scenarios
449-
- [Monitoring and Logging](Operations-Monitoring-and-Logging) - Track broker connection health and system performance
449+
- [Monitoring and Logging](Infrastructure-Monitoring-and-Logging) - Track broker connection health and system performance
450450
- [Admin API](Infrastructure-Admin-API) - Programmatically inspect and manage Kafka cluster configuration

Advanced/CLI.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -114,5 +114,5 @@ Routing Patterns managament via the CLI has its own section. You can read about
114114
## See Also
115115

116116
- [Getting Started](Basics-Getting-Started) - Initial setup and basic CLI usage
117-
- [Deployment](Operations-Deployment) - Using CLI commands in production environments
117+
- [Deployment](Infrastructure-Deployment) - Using CLI commands in production environments
118118
- [Env Variables](Env-Variables) - Environment variables affecting CLI behavior

Advanced/Concurrency-and-Multithreading.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -150,7 +150,7 @@ There are a few ways to measure the saturation in Karafka:
150150

151151
- You can look at the `Enqueued` value in the [Web-UI](Web-UI-Getting-Started). This value indicates the total number of jobs waiting in the internal queues of all the Karafka processes. The high value there indicates increased saturation.
152152
- You can log the `messages.metadata.processing_lag` value, which describes how long a batch had to wait before it was picked up by one of the workers.
153-
- If you are using our [Datadog](Operations-Monitoring-and-Logging#datadog-and-statsd-integration) integration, it contains the `processing_lag` metrics.
153+
- If you are using our [Datadog](Infrastructure-Monitoring-and-Logging#datadog-and-statsd-integration) integration, it contains the `processing_lag` metrics.
154154

155155
Job saturation in Karafka isn't inherently critical, but it may lead to increased consumption lag, resulting in potential delays in processing tasks. This is because when the system is overloaded with jobs, it takes longer to consume and process new incoming data. Moreover, heavily saturated processes can create an additional issue; they may exceed the max.poll.interval.ms configuration parameter. This parameter sets the maximum delay allowed before the Kafka broker considers the consumer unresponsive and reassigns its partitions. In such a scenario, maintaining an optimal balance in job saturation becomes crucial for ensuring efficient message processing.
156156

Advanced/Debugging.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -596,7 +596,7 @@ Don't hesitate to get in touch if you still need clarification after following t
596596
## See Also
597597

598598
- [Problems and Troubleshooting](Problems-and-Troubleshooting) - Common issues and their solutions for Karafka applications
599-
- [Monitoring and Logging](Operations-Monitoring-and-Logging) - Configure comprehensive logging and monitoring for debugging
599+
- [Monitoring and Logging](Infrastructure-Monitoring-and-Logging) - Configure comprehensive logging and monitoring for debugging
600600
- [Error Handling and Back Off Policy](Consumer-Groups-Error-Handling-and-Back-Off-Policy) - Understand error handling mechanisms and retry logic
601601
- [Support](Pro-Support) - Access priority support and direct assistance from the Karafka team
602602
- [FAQ](Basics-FAQ) - Frequently asked questions about Karafka functionality and troubleshooting

Advanced/Embedding.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -265,4 +265,4 @@ The listener thread priority (internal setting `internal.connection.listener_thr
265265
## See Also
266266

267267
- [CLI](CLI) - Command-line interface for running Karafka standalone
268-
- [Deployment](Operations-Deployment) - Strategies for deploying Karafka in various environments
268+
- [Deployment](Infrastructure-Deployment) - Strategies for deploying Karafka in various environments

Advanced/Env-Variables.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -32,5 +32,5 @@ Karafka's behaviour can be altered with the following environment variables:
3232
## See Also
3333

3434
- [Configuration](Basics-Configuration) - Complete configuration reference
35-
- [Deployment](Operations-Deployment) - Using environment variables in deployment
36-
- [Development vs Production](Operations-Development-vs-Production) - Environment-specific settings
35+
- [Deployment](Infrastructure-Deployment) - Using environment variables in deployment
36+
- [Development vs Production](Infrastructure-Application-Development-vs-Production) - Environment-specific settings

Advanced/Exit-codes.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -27,5 +27,5 @@ Each Karafka process defines exit statuses to indicate how the process terminate
2727

2828
## See Also
2929

30-
- [Deployment](Operations-Deployment) - Handling exit codes in production deployments
31-
- [Signals and States](Operations-Signals-and-States) - Understanding process lifecycle and signals
30+
- [Deployment](Infrastructure-Deployment) - Handling exit codes in production deployments
31+
- [Signals and States](Infrastructure-Signals-and-States) - Understanding process lifecycle and signals

0 commit comments

Comments
 (0)