mongoc_client_set_structured_log_opts()#

Synopsis#

bool
mongoc_client_set_structured_log_opts (mongoc_client_t *client,
                                       const mongoc_structured_log_opts_t *opts);

Reconfigures this client’s structured logging subsystem. See Structured Logging.

This function must not be called on clients that are part of a mongoc_client_pool_t. Structured logging for pools must be configured with mongoc_client_pool_set_structured_log_opts() before the first call to mongoc_client_pool_pop().

The mongoc_structured_log_opts_t is copied by the client 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 client.

By default, the mongoc_client_t will have log options captured from the environment during mongoc_client_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().

Parameters#

client: A mongoc_client_t.
opts: A mongoc_structured_log_opts_t allocated with mongoc_structured_log_opts_new(), or NULL to disable structured logging.

Returns#

Returns true when used correctly. If called on a pooled client, returns false and logs a warning.