Skip to content

DOCSP-47056: Monitoring #260

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 7 commits into
base: comp-cov
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions config/redirects
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ raw: ${prefix}/stable -> ${base}/current/
# redirects in standardized docs
[v1.20-*]: ${prefix}/${version}/tutorial/install-php-library/ -> ${base}/${version}/get-started/
[v1.20-*]: ${prefix}/${version}/tutorial/connecting/ -> ${base}/${version}/connect/
[v1.20-*]: ${prefix}/${version}/tutorial/server-selection/ -> ${base}/${version}/monitoring/cluster-monitoring/
[v1.20-*]: ${prefix}/${version}/tutorial/server-selection/ -> ${base}/${version}/monitoring-logging/monitoring/
[v1.20-*]: ${prefix}/${version}/tutorial/crud/ -> ${base}/${version}/read/
[v1.20-*]: ${prefix}/${version}/tutorial/codecs/ -> ${base}/${version}/data-formats/codecs/
[v1.20-*]: ${prefix}/${version}/tutorial/collation/ -> ${base}/${version}/
Expand All @@ -45,7 +45,7 @@ raw: ${prefix}/stable -> ${base}/current/
# note: this mapping does not account for all of the new pages
[*-v1.19]: ${prefix}/${version}/tutorial/install-php-library/ -> ${base}/v1.x/get-started/
[*-v1.19]: ${prefix}/${version}/tutorial/connecting/ -> ${base}/v1.x/connect/
[*-v1.19]: ${prefix}/${version}/tutorial/server-selection/ -> ${base}/v1.x/monitoring/cluster-monitoring/
[*-v1.19]: ${prefix}/${version}/tutorial/server-selection/ -> ${base}/v1.x/monitoring-logging/monitoring/
[*-v1.19]: ${prefix}/${version}/tutorial/crud/ -> ${base}/v1.x/read/
[*-v1.19]: ${prefix}/${version}/tutorial/codecs/ -> ${base}/v1.x/data-formats/codecs/
[*-v1.19]: ${prefix}/${version}/tutorial/collation/ -> ${base}/v1.x/
Expand Down Expand Up @@ -84,7 +84,7 @@ raw: ${prefix}/stable -> ${base}/current/
[*-master]: ${prefix}/${version}/data-formats/codecs/ -> ${base}/${version}/data-formats/custom-types/codecs/
[*-master]: ${prefix}/${version}/databases-collections/time-series/ -> ${base}/${version}/data-formats/time-series/
[*-master]: ${prefix}/${version}/read/change-streams/ -> ${base}/${version}/monitoring-logging/change-streams/
[*-master]: ${prefix}/${version}/monitoring/cluster-monitoring/ -> ${base}/${version}/monitoring-logging/cluster-monitoring/
[*-master]: ${prefix}/${version}/monitoring/cluster-monitoring/ -> ${base}/${version}/monitoring-logging/monitoring/
[*-master]: ${prefix}/${version}/compatibility/ -> ${base}/${version}/references/compatibility/
[*-master]: ${prefix}/${version}/whats-new/ -> ${base}/${version}/references/release-notes/
[*-master]: ${prefix}/${version}/upgrade/ -> ${base}/${version}/references/upgrade/
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,34 @@

require __DIR__ . '/vendor/autoload.php';

// start-mysubscriber
class MySubscriber implements MongoDB\Driver\Monitoring\SDAMSubscriber
// start-command-subscriber
class MyCommandSubscriber implements MongoDB\Driver\Monitoring\CommandSubscriber
{
private $stream;

public function __construct($stream)
{
$this->stream = $stream;
}

public function commandStarted(MongoDB\Driver\Monitoring\CommandStartedEvent $event): void
{
fwrite($this->stream, sprintf(
'Started command #%d "%s": %s%s',
$event->getRequestId(),
$event->getCommandName(),
MongoDB\BSON\Document::fromPHP($event->getCommand())->toCanonicalExtendedJSON(),
PHP_EOL,
));
}

public function commandSucceeded(MongoDB\Driver\Monitoring\CommandSucceededEvent $event): void {}
public function commandFailed(MongoDB\Driver\Monitoring\CommandFailedEvent $event): void {}
}
// end-command-subscriber

// start-sdam-subscriber
class MySDAMSubscriber implements MongoDB\Driver\Monitoring\SDAMSubscriber
{
private $stream;

Expand All @@ -18,6 +44,7 @@ public function serverOpening(MongoDB\Driver\Monitoring\ServerOpeningEvent $even
'Server opening on %s:%s\n',
$event->getHost(),
$event->getPort(),
PHP_EOL,
);
}

Expand All @@ -30,20 +57,23 @@ public function topologyChanged(MongoDB\Driver\Monitoring\TopologyChangedEvent $
public function topologyClosed(MongoDB\Driver\Monitoring\TopologyClosedEvent $event): void {}
public function topologyOpening(MongoDB\Driver\Monitoring\TopologyOpeningEvent $event): void {}
}
// end-mysubscriber
// end-sdam-subscriber

$uri = getenv('MONGODB_URI') ?: throw new RuntimeException('Set the MONGODB_URI variable to your connection URI');
$client = new MongoDB\Client($uri);

$collection = $client->db->my_coll;

// start-add-sub
$subscriber = new MySubscriber(STDERR);
$client->addSubscriber($subscriber);
// end-add-sub
// start-add-subs
$commandSub = new MyCommandSubscriber(STDERR);
$sdamSub = new MySDAMSubscriber(STDERR);

$client->addSubscriber($commandSub);
$client->addSubscriber($sdamSub);
// end-add-subs

$collection->insertOne(['x' => 100]);

// start-remove-sub
$client->removeSubscriber($subscriber);
$client->removeSubscriber($commandSub);
// end-remove-sub
6 changes: 3 additions & 3 deletions source/monitoring-logging.txt
Original file line number Diff line number Diff line change
Expand Up @@ -8,11 +8,11 @@ Monitoring and Logging
.. toctree::
:caption: Monitoring categories

Cluster Monitoring </monitoring-logging/cluster-monitoring>
Monitoring </monitoring-logging/monitoring>
Change Streams </monitoring-logging/change-streams>

.. /monitoring/command-monitoring
.. /monitoring/connection-monitoring

- :ref:`Cluster Monitoring <php-cluster-monitoring>`: Monitor changes
in your cluster configuration
- :ref:`Monitor Application Events <php-monitoring>`: Monitor changes
in your application
163 changes: 0 additions & 163 deletions source/monitoring-logging/cluster-monitoring.txt

This file was deleted.

Loading
Loading