Skip to main content

DatabasesUpdateLogsinkBody

rsdo

Struct DatabasesUpdateLogsinkBody 

Source 
pub struct DatabasesUpdateLogsinkBody {
    pub config: DatabasesUpdateLogsinkBodyConfig,
}
Expand description

DatabasesUpdateLogsinkBody

JSON schema 
{
 "type": "object",
 "required": [
   "config"
 ],
 "properties": {
   "config": {
     "anyOf": [
       {
         "type": "object",
         "required": [
           "format",
           "port",
           "server",
           "tls"
         ],
         "properties": {
           "ca": {
             "description": "PEM encoded CA certificate",
             "examples": [
               "-----BEGIN CERTIFICATE-----\\n...\\n-----END CERTIFICATE-----\\n"
             ],
             "type": "string"
           },
           "cert": {
             "description": "(PEM format) client cert to use",
             "examples": [
               "-----BEGIN CERTIFICATE-----\\n...\\n-----END CERTIFICATE-----\\n"
             ],
             "type": "string"
           },
           "format": {
             "description": "Message format used by the server, this can be either rfc3164 (the old BSD style message format), `rfc5424` (current syslog message format) or custom",
             "examples": [
               "rfc5424"
             ],
             "type": "string",
             "enum": [
               "rfc5424",
               "rfc3164",
               "custom"
             ]
           },
           "key": {
             "description": "(PEM format) client key if the server requires client authentication",
             "examples": [
               "-----BEGIN PRIVATE KEY-----\\nREDACTED-EXAMPLE-KEY\\n-----END PRIVATE KEY-----\\n"
             ],
             "type": "string"
           },
           "logline": {
             "description": "Conditional (required if `format` == `custom`).\n\nSyslog log line template for a custom format, supporting limited rsyslog style templating (using `%tag%`). Supported tags are: `HOSTNAME`, `app-name`, `msg`, `msgid`, `pri`, `procid`, `structured-data`, `timestamp` and `timestamp:::date-rfc3339`.\n\n---\n**Datadog Integration Example for Non-Mongo clusters**:\n```text\nDD_KEY <%pri%>1 %timestamp:::date-rfc3339% %HOSTNAME%.DB_NAME %app-name% - - - %msg%\n```text\n- Replace `DD_KEY` with your actual Datadog API key.\n- Replace `DB_NAME` with the actual name of your database cluster.\n- Configure the Server:\n  - US Region: Use `intake.logs.datadoghq.com`\n  - EU Region: Use `tcp-intake.logs.datadoghq.eu`\n- Configure the Port:\n  - US Region: Use port `10516`\n  - EU Region: Use port `443`\n- Enable TLS:\n  - Ensure the TLS checkbox is enabled.\n- Note: This configuration applies to **non-Mongo clusters only**. For **Mongo clusters**, use the `datadog_logsink` integration instead.\n",
             "examples": [
               "\\<%pri%\\>%timestamp:::date-rfc3339% %HOSTNAME% %app-name% %msg%"
             ],
             "type": "string"
           },
           "port": {
             "description": "The internal port on which the rsyslog server is listening",
             "examples": [
               514
             ],
             "type": "integer",
             "maximum": 65535.0
           },
           "sd": {
             "description": "content of the structured data block of rfc5424 message",
             "examples": [
               "TOKEN tag=\"LiteralValue\""
             ],
             "type": "string"
           },
           "server": {
             "description": "DNS name or IPv4 address of the rsyslog server",
             "examples": [
               "192.168.0.1"
             ],
             "type": "string"
           },
           "tls": {
             "description": "Use TLS (as the messages are not filtered and may contain sensitive information, it is highly recommended to set this to true if the remote server supports it)",
             "examples": [
               false
             ],
             "type": "boolean"
           }
         }
       },
       {
         "type": "object",
         "required": [
           "index_prefix",
           "url"
         ],
         "properties": {
           "ca": {
             "description": "PEM encoded CA certificate",
             "examples": [
               "-----BEGIN CERTIFICATE-----\\n...\\n-----END CERTIFICATE-----\\n"
             ],
             "type": "string"
           },
           "index_days_max": {
             "description": "Maximum number of days of logs to keep",
             "default": 7,
             "examples": [
               5
             ],
             "type": "integer",
             "maximum": 10000.0,
             "minimum": 1.0
           },
           "index_prefix": {
             "description": "Elasticsearch index prefix",
             "examples": [
               "elastic-logs"
             ],
             "type": "string"
           },
           "timeout": {
             "description": "Elasticsearch request timeout limit",
             "default": 10.0,
             "examples": [
               10.0
             ],
             "type": "number",
             "format": "float",
             "maximum": 120.0,
             "minimum": 10.0
           },
           "url": {
             "description": "Elasticsearch connection URL",
             "examples": [
               "https://user:passwd@192.168.0.1:9200"
             ],
             "type": "string"
           }
         }
       },
       {
         "type": "object",
         "required": [
           "index_prefix",
           "url"
         ],
         "properties": {
           "ca": {
             "description": "PEM encoded CA certificate",
             "examples": [
               "-----BEGIN CERTIFICATE-----\\n...\\n-----END CERTIFICATE-----\\n"
             ],
             "type": "string"
           },
           "index_days_max": {
             "description": "Maximum number of days of logs to keep",
             "default": 7,
             "examples": [
               5
             ],
             "type": "integer",
             "maximum": 10000.0,
             "minimum": 1.0
           },
           "index_prefix": {
             "description": "Opensearch index prefix",
             "examples": [
               "opensearch-logs"
             ],
             "type": "string"
           },
           "timeout": {
             "description": "Opensearch request timeout limit",
             "default": 10.0,
             "examples": [
               10.0
             ],
             "type": "number",
             "format": "float",
             "maximum": 120.0,
             "minimum": 10.0
           },
           "url": {
             "description": "Opensearch connection URL",
             "examples": [
               "https://user:passwd@192.168.0.1:9200"
             ],
             "type": "string"
           }
         }
       },
       {
         "description": "Configuration for Datadog integration **applicable only to MongoDB clusters**.\n",
         "type": "object",
         "required": [
           "datadog_api_key",
           "site"
         ],
         "properties": {
           "datadog_api_key": {
             "description": "Datadog API key",
             "examples": [
               "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx"
             ],
             "type": "string"
           },
           "site": {
             "description": "Datadog connection URL",
             "examples": [
               "http-intake.logs.datadoghq.com"
             ],
             "type": "string"
           }
         }
       }
     ]
   }
 }
}

Fields§

§config: DatabasesUpdateLogsinkBodyConfig

Trait Implementations§

Source§

impl Clone for DatabasesUpdateLogsinkBody

Source§

fn clone(&self) -> DatabasesUpdateLogsinkBody

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
Source§

impl Debug for DatabasesUpdateLogsinkBody

Source§

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter. Read more
Source§

impl<'de> Deserialize<'de> for DatabasesUpdateLogsinkBody

Source§

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>
where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more
Source§

impl From<&DatabasesUpdateLogsinkBody> for DatabasesUpdateLogsinkBody

Source§

fn from(value: &DatabasesUpdateLogsinkBody) -> Self

Converts to this type from the input type.
Source§

impl Serialize for DatabasesUpdateLogsinkBody

Source§

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>
where __S: Serializer,

Serialize this value into the given Serde serializer. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self> ⓘ

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self> ⓘ

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> PolicyExt for T
where T: ?Sized,

Source§

fn and<P, B, E>(self, other: P) -> And<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow only if self and other return Action::Follow. Read more
Source§

fn or<P, B, E>(self, other: P) -> Or<T, P>
where T: Sized + Policy<B, E>, P: Policy<B, E>,

Create a new Policy that returns Action::Follow if either self or other returns Action::Follow. Read more
Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> ⓘ
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self> ⓘ

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more