Struct RiLogAnalyticsModule 

pub struct RiLogAnalyticsModule { /* private fields */ }

Log analytics module for Ri.

This module implements the ServiceModule trait and provides analytics functionality by listening to hook events and generating comprehensive reports.

Usage

The module is automatically added by the RiAppBuilder and doesn’t need to be explicitly configured in most cases. It can be enabled/disabled through the configuration file.

Configuration

analytics:
  enabled: true  # Enable or disable analytics

Implementations

impl RiLogAnalyticsModule

pub fn new() -> Self

Creates a new instance of the log analytics module.

Returns a new RiLogAnalyticsModule with default settings.

Trait Implementations

impl Default for RiLogAnalyticsModule

fn default() -> Self

Returns the “default value” for a type.

impl<'py> IntoPyObject<'py> for RiLogAnalyticsModule

type Target = RiLogAnalyticsModule

The Python output type

type Output = Bound<'py, <RiLogAnalyticsModule as IntoPyObject<'py>>::Target>

The smart pointer type to use.

type Error = PyErr

The type returned in the event of a conversion error.

fn into_pyobject( self, py: Python<'py>, ) -> Result<<Self as IntoPyObject<'_>>::Output, <Self as IntoPyObject<'_>>::Error>

Performs the conversion.

impl PyClass for RiLogAnalyticsModule

type Frozen = False

Whether the pyclass is frozen.

impl PyClassImpl for RiLogAnalyticsModule

const IS_BASETYPE: bool = false

#[pyclass(subclass)]

const IS_SUBCLASS: bool = false

#[pyclass(extends=…)]

const IS_MAPPING: bool = false

#[pyclass(mapping)]

const IS_SEQUENCE: bool = false

#[pyclass(sequence)]

const IS_IMMUTABLE_TYPE: bool = false

#[pyclass(immutable_type)]

const RAW_DOC: &'static CStr = c"Log analytics module for Ri.\n\nThis module implements the `ServiceModule` trait and provides analytics functionality\nby listening to hook events and generating comprehensive reports.\n\n## Usage\n\nThe module is automatically added by the `RiAppBuilder` and doesn\'t need to be explicitly\nconfigured in most cases. It can be enabled/disabled through the configuration file.\n\n## Configuration\n\n```yaml\nanalytics:\n enabled: true # Enable or disable analytics\n```\x00"

Docstring for the class provided on the struct or enum.

const DOC: &'static CStr

Fully rendered class doc, including the text_signature if a constructor is defined.

type BaseType = PyAny

Base class

type ThreadChecker = SendablePyClass<RiLogAnalyticsModule>

This handles following two situations:

type PyClassMutability = <<PyAny as PyClassBaseType>::PyClassMutability as PyClassMutability>::MutableChild

Immutable or mutable

type Dict = PyClassDummySlot

Specify this class has #[pyclass(dict)] or not.

type WeakRef = PyClassDummySlot

Specify this class has #[pyclass(weakref)] or not.

type BaseNativeType = PyAny

The closest native ancestor. This is PyAny by default, and when you declare #[pyclass(extends=PyDict)], it’s PyDict.

fn items_iter() -> PyClassItemsIter

fn lazy_type_object() -> &'static LazyTypeObject<Self>

fn dict_offset() -> Option<isize>

fn weaklist_offset() -> Option<isize>

impl PyTypeInfo for RiLogAnalyticsModule

const NAME: &'static str = "RiLogAnalyticsModule"

Class name.

const MODULE: Option<&'static str> = ::core::option::Option::None

Module name, if any.

fn type_object_raw(py: Python<'_>) -> *mut PyTypeObject

Returns the PyTypeObject instance for this type.

fn type_object(py: Python<'_>) -> Bound<'_, PyType>

Returns the safe abstraction over the type object.

fn is_type_of(object: &Bound<'_, PyAny>) -> bool

Checks if object is an instance of this type or a subclass of this type.

fn is_exact_type_of(object: &Bound<'_, PyAny>) -> bool

Checks if object is an instance of this type.

impl ServiceModule for RiLogAnalyticsModule

fn name(&self) -> &str

Returns the name of the analytics module.

This name is used for identification, logging, and dependency resolution.

fn is_critical(&self) -> bool

Indicates if the analytics module is critical to the operation of the system.

The analytics module is non-critical, meaning it can fail without causing the entire system to fail.

fn init(&mut self, ctx: &mut RiServiceContext) -> RiResult<()>

Initializes the analytics module.

This method:

1. Reads the analytics configuration from the service context
2. Enables or disables the module based on configuration
3. Registers hook handlers if the module is enabled

Parameters

• ctx: The service context containing configuration and hooks

Returns

A RiResult indicating success or failure

fn after_shutdown(&mut self, ctx: &mut RiServiceContext) -> RiResult<()>

Flushes analytics data after the application has shutdown.

This method generates a final analytics report and writes it to a file after all modules have been shutdown.

Parameters

• ctx: The service context containing file system and logging capabilities

Returns

A RiResult indicating success or failure

fn priority(&self) -> i32

Returns the priority of the module.

fn dependencies(&self) -> Vec<&str>

Returns the list of module dependencies.

fn before_start(&mut self, _ctx: &mut RiServiceContext) -> RiResult<()>

Prepares the module for startup.

fn start(&mut self, _ctx: &mut RiServiceContext) -> RiResult<()>

Starts the service module.

fn after_start(&mut self, _ctx: &mut RiServiceContext) -> RiResult<()>

Performs post-startup operations.

fn before_shutdown(&mut self, _ctx: &mut RiServiceContext) -> RiResult<()>

Prepares the module for shutdown.

fn shutdown(&mut self, _ctx: &mut RiServiceContext) -> RiResult<()>

Shuts down the service module.

impl DerefToPyAny for RiLogAnalyticsModule

impl ExtractPyClassWithClone for RiLogAnalyticsModule