Add documentation for queue statistics

commercetools · Jul 4, 2024 · 112d181 · 112d181
1 parent d854935
commit 112d181
Show file tree

Hide file tree

Showing 3 changed files with 5 additions and 0 deletions.
diff --git a/docs/getting-started/directory.conf b/docs/getting-started/directory.conf
@@ -4,6 +4,7 @@ laika.navigationOrder = [
   queues.md
   publishing.md
   subscribing.md
+  stats.md
   administration.md
   serialization.md
 ]
diff --git a/docs/getting-started/queues.md b/docs/getting-started/queues.md
@@ -13,6 +13,8 @@ There are several views possible on a queue:
 
  - as a `QueuePublisher` when you only need to [publish messages](publishing.md) to an existing queue.
  - as a `QueueSubscriber` when you only need to [subscribe](subscribing.md) to an existing queue.
+ - as a `QueueStatistics` when you only need to [gather queue statistics](stats.md) from an existing queue.
+ - as a `QueueSubscriber` when you only need to [subscribe](subscribing.md) to an existing queue.
  - as a `QueueAdministration` when you need to [manage](administration.md) queues (creation, deletion, ...).
 
 The entry point is the `QueueClient` factory for each underlying queue system.

diff --git a/docs/systems/index.md b/docs/systems/index.md
@@ -16,13 +16,15 @@ import com.commercetools.queue.{
   QueueClient,
   QueueAdministration,
   QueuePublisher,
+  QueueStatistics,
   QueueSubscriber,
   Serializer
 }
 import com.commercetools.queue.testkit.QueueClientSuite
 
 class MyQueueClient[F[_]] extends QueueClient[F] {
   def administration: QueueAdministration[F] = ???
+  def statistics(name: String): QueueStatistics[F] = ???
   def publish[T: Serializer](name: String): QueuePublisher[F,T] = ???
   def subscribe[T: Deserializer](name: String): QueueSubscriber[F,T] = ???