GSP
Quick Navigator

Search Site

Unix VPS
A - Starter
B - Basic
C - Preferred
D - Commercial
MPS - Dedicated
Previous VPSs
* Sign Up! *

Support
Contact Us
Online Help
Handbooks
Domain Status
Man Pages

FAQ
Virtual Servers
Pricing
Billing
Technical

Network
Facilities
Connectivity
Topology Map

Miscellaneous
Server Agreement
Year 2038
Credits
 

USA Flag

 

 

Man Pages
MONGOC_CLIENT_POOL_SET_STRUCTURED_LOG_OPTS(3) libmongoc MONGOC_CLIENT_POOL_SET_STRUCTURED_LOG_OPTS(3)

bool
mongoc_client_pool_set_structured_log_opts (mongoc_client_pool_t *pool,

const mongoc_structured_log_opts_t *opts);


Reconfigures this client pool's structured logging subsystem. See Structured Logging.

The mongoc_structured_log_opts_t is copied by the pool and may be safely destroyed by the caller after this API call completes. The application is responsible for ensuring any user_data referenced by opts remains valid for the lifetime of the pool.

By default, the mongoc_client_pool_t will have log options captured from the environment during mongoc_client_pool_new(). See mongoc_structured_log_opts_new() for a list of the supported options.

The structured logging subsystem may be disabled by passing NULL as opts or equivalently by passing NULL as the mongoc_structured_log_func_t in mongoc_structured_log_opts_set_handler().

  • pool: A mongoc_client_pool_t.
  • opts: A mongoc_structured_log_opts_t allocated with mongoc_structured_log_opts_new(), or NULL to disable structured logging.

Returns true when used correctly. If called multiple times per pool or after the first client is initialized, returns false and logs a warning.

This function can only be called once on a pool, and must be called before the first call to mongoc_client_pool_pop().

Thread safety within the handler is the application's responsibility. Handlers may be invoked concurrently by multiple pool users.

SEE ALSO:

Structured Logging



MongoDB, Inc

2009-present, MongoDB, Inc.

July 3, 2025 1.30.4

Search for    or go to Top of page |  Section 3 |  Main Index

Powered by GSP Visit the GSP FreeBSD Man Page Interface.
Output converted with ManDoc.