SolrLogAuditLoggerPlugin (Solr 8.1.0 API)

java.lang.Object
- org.apache.solr.security.AuditLoggerPlugin
- - org.apache.solr.security.SolrLogAuditLoggerPlugin

All Implemented Interfaces:

Closeable, AutoCloseable, Runnable, SolrInfoBean, SolrMetricProducer
```
public class SolrLogAuditLoggerPlugin
extends AuditLoggerPlugin
```
Audit logger that writes to the Solr log. This interface may change in next release and is marked experimental

Since:

8.1.0

WARNING: This API is experimental and might change in incompatible ways in the next release.

Nested Class Summary
- Nested classes/interfaces inherited from class org.apache.solr.security.AuditLoggerPlugin
  AuditLoggerPlugin.AuditEventFormatter, AuditLoggerPlugin.JSONAuditEventFormatter, AuditLoggerPlugin.MuteRule
- Nested classes/interfaces inherited from interface org.apache.solr.core.SolrInfoBean
  SolrInfoBean.Category, SolrInfoBean.Group

Field Summary
- Fields inherited from class org.apache.solr.security.AuditLoggerPlugin
  eventTypes, formatter, metricManager, numErrors, numLogged, numLost, queuedTime, registryName, requestTimes, totalTime

Constructor Summary

Constructors
Constructor Description

SolrLogAuditLoggerPlugin()

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`void`	`audit(AuditEvent event)`	Audit logs an event to Solr log.
`void`	`init(Map<String,Object> pluginConfig)`	Initialize the plugin from security.json

Methods inherited from class org.apache.solr.security.AuditLoggerPlugin
auditAsync, close, doAudit, getCategory, getDescription, getMetricNames, getMetricRegistry, getName, initializeMetrics, run, setFormatter, shouldLog, shouldMute, waitForQueueToDrain

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.apache.solr.core.SolrInfoBean
getMetricsSnapshot, registerMetricName

- Constructor Detail
  - SolrLogAuditLoggerPlugin
```
public SolrLogAuditLoggerPlugin()
```
- Method Detail
  - init
```
public void init(Map<String,Object> pluginConfig)
```
    Initialize the plugin from security.json
    
    Overrides:
    
    init in class AuditLoggerPlugin
    
    Parameters:
    
    pluginConfig - the config for the plugin
  - audit
```
public void audit(AuditEvent event)
```
    Audit logs an event to Solr log. The event should be a AuditEvent to be able to pull context info
    
    Specified by:
    
    audit in class AuditLoggerPlugin
    
    Parameters:
    
    event - the event to log