Package io.openems.backend.metadata.odoo

Class MetadataOdoo

java.lang.Object

io.openems.backend.common.component.AbstractOpenemsBackendComponent

io.openems.backend.common.metadata.AbstractMetadata

io.openems.backend.metadata.odoo.MetadataOdoo

All Implemented Interfaces:

DebugLoggable, AppCenterMetadata, AppCenterMetadata.EdgeData, AppCenterMetadata.UiData, Mailer, Metadata, org.osgi.service.event.EventHandler

public class MetadataOdoo
extends AbstractMetadata
implements AppCenterMetadata, AppCenterMetadata.EdgeData, AppCenterMetadata.UiData, Metadata, Mailer, org.osgi.service.event.EventHandler, DebugLoggable

Nested Class Summary

Nested classes/interfaces inherited from interface io.openems.backend.common.metadata.AppCenterMetadata

AppCenterMetadata.EdgeData, AppCenterMetadata.UiData

Nested classes/interfaces inherited from interface io.openems.backend.common.metadata.Metadata

Metadata.Events, Metadata.GenericSystemLog

Field Summary

Fields

Modifier and Type	Field	Description
protected OdooHandler	odooHandler
protected PostgresHandler	postgresHandler

Constructor Summary

Constructors

Constructor	Description
MetadataOdoo()

Method Summary

Modifier and Type	Method	Description
void	addEdgeToUser(User user, Edge edge)	Assigns Edge to current user.
User	authenticate(String sessionId)	Tries to authenticate at the Odoo server using a sessionId from a cookie.
User	authenticate(String username, String password)	Authenticates the User by username and password.
String	debugLog()	Gets some output that is suitable for a continuous Debug log.
Map<String,com.google.gson.JsonElement>	debugMetrics()	Gets some output that is suitable for a debug metrics to write down as Timedata.
EdgeHandler	edge()	Handles operations with Edge.
Collection<Edge>	getAllOfflineEdges()	Gets all Offline-Edges.
Optional<Edge>	getEdge(String edgeId)	Get an Edge by its unique Edge-ID.
Optional<Edge>	getEdgeBySetupPassword(String setupPassword)	Get an Edge by Edge-SetupPassword.
Optional<String>	getEdgeIdForApikey(String apikey)	Gets the Edge-ID for an API-Key, i.e.
GetEdgesResponse.EdgeMetadata	getEdgeMetadataForUser(User user, String edgeId)	Gets the Role for a edge of the current user.
List<OfflineEdgeAlertingSetting>	getEdgeOfflineAlertingSettings(String edgeId)	Gets all the offline-edge-alerting settings for given edge id.
org.osgi.service.event.EventAdmin	getEventAdmin()	Returns an EventAdmin, used by Edge objects.
OdooHandler	getOdooHandler()	Gets the OdooHandler.
List<GetEdgesResponse.EdgeMetadata>	getPageDevice(User user, GetEdgesRequest.PaginationOptions paginationOptions)	Gets a map of Edge-IDs with the role of the given user.
PostgresHandler	getPostgresHandler()	Gets the PostgresHandler.
Optional<String>	getSerialNumberForEdge(Edge edge)	Get serial number for the given Edge.
byte[]	getSetupProtocol(User user, int setupProtocolId)	Returns the Setup Protocol PDF for the given id.
com.google.gson.JsonObject	getSetupProtocolData(User user, String edgeId)	Return the Setup Protocol data as a JsonObject.
Optional<Level>	getSumState(String edgeId)	Get the SumState of the edge with the given edgeId.
List<SumStateAlertingSetting>	getSumStateAlertingSettings(String edgeId)	Gets all the sumState-alerting settings for given edge id.
String	getSuppliableKey(User user, String edgeId, String appId)	Gets a key that can be supplied to the installation of the given app.
Optional<User>	getUser(String userId)	Gets the User for the given User-ID.
List<UserAlertingSettings>	getUserAlertingSettings(String edgeId)	Gets all the alerting settings for given edge id.
UserAlertingSettings	getUserAlertingSettings(String edgeId, String userId)	Gets the alerting settings for given edge id and userId.
Map<String,Object>	getUserInformation(User user)	Gets information about the given user User.
void	handleEvent(org.osgi.service.event.Event event)
boolean	isAppFree(User user, String appId)	Gets if the given app is free.
void	logError(org.slf4j.Logger log, String message)	Log an error message including the Component ID.
void	logGenericSystemLog(Metadata.GenericSystemLog systemLog)	Handles a Systemlog-Message.
void	logInfo(org.slf4j.Logger log, String message)	Log an info message including the Component ID.
void	logout(User user)	Closes a session for a User.
void	logWarn(org.slf4j.Logger log, String message)	Log a warn message including the Component ID.
void	registerUser(com.google.gson.JsonObject jsonObject, String oem)	Register a user.
void	sendAddDeinstallAppInstanceHistory(String edgeId, String appId, UUID instanceId, String userId)	Sends a request to add a deinstall history entry.
void	sendAddInstallAppInstanceHistory(String key, String edgeId, String appId, UUID instanceId, String userId)	Sends a request to add a install app history entry.
void	sendAddRegisterKeyHistory(String edgeId, String appId, String key, User user)	Sends a request to register a key.
void	sendAddUnregisterKeyHistory(String edgeId, String appId, String key, User user)	Sends a request to unregister a key.
com.google.gson.JsonObject	sendGetInstalledApps(String edgeId)	Sends a request to get all installed apps on the edge that are logged in the backend these apps may not be actually on the edge.
com.google.gson.JsonArray	sendGetPossibleApps(String key, String edgeId)	Sends a request to get all apps that can be installed with the given key.
com.google.gson.JsonArray	sendGetRegisteredKeys(String edgeId, String appId)	Sends a request to get all registered keys to the given edge and app.
com.google.gson.JsonObject	sendIsKeyApplicable(String key, String edgeId, String appId)	Sends a request if the key can be applied to the given edge and app id.
void	sendMail(ZonedDateTime sendAt, String template, com.google.gson.JsonElement params)	Send alerting mail at stamp to users.
void	setUserAlertingSettings(User user, String edgeId, List<UserAlertingSettings> settings)	Sets the alerting settings for the given list of users.
void	setUserInformation(User user, com.google.gson.JsonObject jsonObject)	Update the given user User with new information JsonObject.
int	submitSetupProtocol(User user, com.google.gson.JsonObject jsonObject)	Submit the installation assistant protocol.
void	updateUserLanguage(User user, Language language)	Update language from given user.
void	updateUserSettings(User user, com.google.gson.JsonObject settings)	Updates the user settings.

Methods inherited from class io.openems.backend.common.metadata.AbstractMetadata

isInitialized, setInitialized

Methods inherited from class io.openems.backend.common.component.AbstractOpenemsBackendComponent

getName, logDebug, logDebug, logError, logInfo, logWarn

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface io.openems.backend.common.metadata.Metadata

addEdgeToUser, getEdgeOrError, isInitialized

Field Details

odooHandler

protected OdooHandler odooHandler

postgresHandler

protected PostgresHandler postgresHandler

Constructor Details

MetadataOdoo

public MetadataOdoo()

Method Details

authenticate

public User authenticate(String username,
 String password)
                  throws OpenemsError.OpenemsNamedException

Description copied from interface: Metadata

Authenticates the User by username and password.

Specified by:

authenticate in interface Metadata

Parameters:

username - the Username

password - the Password

Returns:

the User

Throws:

OpenemsError.OpenemsNamedException - on error

authenticate

public User authenticate(String sessionId)
                  throws OpenemsError.OpenemsNamedException

Tries to authenticate at the Odoo server using a sessionId from a cookie.

Specified by:

authenticate in interface Metadata

Parameters:

sessionId - the Session-ID

Returns:

the User

Throws:

OpenemsException - on error

OpenemsError.OpenemsNamedException - on error

logout

public void logout(User user)

Description copied from interface: Metadata

Closes a session for a User.

Specified by:

logout in interface Metadata

Parameters:

user - the User

getEdgeIdForApikey

public Optional<String> getEdgeIdForApikey(String apikey)

Description copied from interface: Metadata

Gets the Edge-ID for an API-Key, i.e. authenticates the API-Key.

Specified by:

getEdgeIdForApikey in interface Metadata

Parameters:

apikey - the API-Key

Returns:

the Edge-ID or Empty

getEdgeBySetupPassword

public Optional<Edge> getEdgeBySetupPassword(String setupPassword)

Description copied from interface: Metadata

Get an Edge by Edge-SetupPassword.

Specified by:

getEdgeBySetupPassword in interface Metadata

Parameters:

setupPassword - to find Edge

Returns:

Edge as a Optional

getEdge

public Optional<Edge> getEdge(String edgeId)

Description copied from interface: Metadata

Get an Edge by its unique Edge-ID.

Specified by:

getEdge in interface Metadata

Parameters:

edgeId - the Edge-ID

Returns:

the Edge as Optional

getUser

public Optional<User> getUser(String userId)

Description copied from interface: Metadata

Gets the User for the given User-ID.

Specified by:

getUser in interface Metadata

Parameters:

userId - the User-ID

Returns:

the User, or Empty

getAllOfflineEdges

public Collection<Edge> getAllOfflineEdges()

Description copied from interface: Metadata

Gets all Offline-Edges.

Specified by:

getAllOfflineEdges in interface Metadata

Returns:

collection of Edges.

getOdooHandler

public OdooHandler getOdooHandler()

Gets the OdooHandler.

Returns:

the OdooHandler

getPostgresHandler

public PostgresHandler getPostgresHandler()

Gets the PostgresHandler.

Returns:

the PostgresHandler

logInfo

public void logInfo(org.slf4j.Logger log,
 String message)

Description copied from class: AbstractOpenemsBackendComponent

Log an info message including the Component ID.

Overrides:

logInfo in class AbstractOpenemsBackendComponent

Parameters:

log - the Logger that is used for writing the log

message - the Info-message

logWarn

public void logWarn(org.slf4j.Logger log,
 String message)

Description copied from class: AbstractOpenemsBackendComponent

Log a warn message including the Component ID.

Overrides:

logWarn in class AbstractOpenemsBackendComponent

Parameters:

log - the Logger that is used for writing the log

message - the Warn-message

logError

public void logError(org.slf4j.Logger log,
 String message)

Description copied from class: AbstractOpenemsBackendComponent

Log an error message including the Component ID.

Overrides:

logError in class AbstractOpenemsBackendComponent

Parameters:

log - the Logger that is used for writing the log

message - the Error-message

addEdgeToUser

public void addEdgeToUser(User user,
 Edge edge)
                   throws OpenemsError.OpenemsNamedException

Description copied from interface: Metadata

Assigns Edge to current user.

If assignment fails, an OpenemsNamedException is thrown.

Specified by:

addEdgeToUser in interface Metadata

Parameters:

user - The User

edge - The Edge

Throws:

OpenemsError.OpenemsNamedException - on error

getUserInformation

public Map<String,Object> getUserInformation(User user)
                                      throws OpenemsError.OpenemsNamedException

Description copied from interface: Metadata

Gets information about the given user User.

Specified by:

getUserInformation in interface Metadata

Parameters:

user - User to read information

Returns:

Map about the user

Throws:

OpenemsError.OpenemsNamedException - on error

setUserInformation

public void setUserInformation(User user,
 com.google.gson.JsonObject jsonObject)
                        throws OpenemsError.OpenemsNamedException

Description copied from interface: Metadata

Update the given user User with new information JsonObject.

Specified by:

setUserInformation in interface Metadata

Parameters:

user - User to update

jsonObject - JsonObject information about the user

Throws:

OpenemsError.OpenemsNamedException - on error

getSetupProtocol

public byte[] getSetupProtocol(User user,
 int setupProtocolId)
                        throws OpenemsError.OpenemsNamedException

Description copied from interface: Metadata

Returns the Setup Protocol PDF for the given id.

Specified by:

getSetupProtocol in interface Metadata

Parameters:

user - User the current user

setupProtocolId - the setup protocol id to search

Returns:

the Setup Protocol PDF as a byte array

Throws:

OpenemsError.OpenemsNamedException - on error

getSetupProtocolData

public com.google.gson.JsonObject getSetupProtocolData(User user,
 String edgeId)
                                                throws OpenemsError.OpenemsNamedException

Description copied from interface: Metadata

Return the Setup Protocol data as a JsonObject.

Specified by:

getSetupProtocolData in interface Metadata

Parameters:

user - User the current user

edgeId - the Edge ID to get the data

Returns:

Setup Protocol as a JsonObject

Throws:

OpenemsError.OpenemsNamedException - on error

submitSetupProtocol

public int submitSetupProtocol(User user,
 com.google.gson.JsonObject jsonObject)
                        throws OpenemsError.OpenemsNamedException

Description copied from interface: Metadata

Submit the installation assistant protocol.

Specified by:

submitSetupProtocol in interface Metadata

Parameters:

user - User the current user

jsonObject - JsonObject the setup protocol

Returns:

id of created setup protocol

Throws:

OpenemsError.OpenemsNamedException - on error

registerUser

public void registerUser(com.google.gson.JsonObject jsonObject,
 String oem)
                  throws OpenemsError.OpenemsNamedException

Description copied from interface: Metadata

Register a user.

Specified by:

registerUser in interface Metadata

Parameters:

jsonObject - JsonObject that represents an user

oem - OEM name

Throws:

OpenemsError.OpenemsNamedException - on error

updateUserLanguage

public void updateUserLanguage(User user,
 Language language)
                        throws OpenemsError.OpenemsNamedException

Description copied from interface: Metadata

Update language from given user.

Specified by:

updateUserLanguage in interface Metadata

Parameters:

user - User the current user

language - to set language

Throws:

OpenemsError.OpenemsNamedException - on error

getEventAdmin

public org.osgi.service.event.EventAdmin getEventAdmin()

Description copied from interface: Metadata

Returns an EventAdmin, used by Edge objects.

Specified by:

getEventAdmin in interface Metadata

Returns:

EventAdmin

handleEvent

public void handleEvent(org.osgi.service.event.Event event)

Specified by:

handleEvent in interface org.osgi.service.event.EventHandler

logGenericSystemLog

public void logGenericSystemLog(Metadata.GenericSystemLog systemLog)

Description copied from interface: Metadata

Handles a Systemlog-Message.

Specified by:

logGenericSystemLog in interface Metadata

Parameters:

systemLog - the log

edge

public EdgeHandler edge()

Description copied from interface: Metadata

Handles operations with Edge.

To be completed. This should eventually replace Edge.

Specified by:

edge in interface Metadata

Returns:

an EdgeHandler

getSerialNumberForEdge

public Optional<String> getSerialNumberForEdge(Edge edge)

Description copied from interface: Metadata

Get serial number for the given Edge.

Specified by:

getSerialNumberForEdge in interface Metadata

Parameters:

edge - Edge to search for serial number

Returns:

Serial number or empty Optional

sendMail

public void sendMail(ZonedDateTime sendAt,
 String template,
 com.google.gson.JsonElement params)

Description copied from interface: Mailer

Send alerting mail at stamp to users.

Specified by:

sendMail in interface Mailer

Parameters:

sendAt - time stamp at which the mail was sent

template - Id of the Template to use

params - mail data (e.g. recipients, subject, ...)

sendIsKeyApplicable

public com.google.gson.JsonObject sendIsKeyApplicable(String key,
 String edgeId,
 String appId)
                                               throws OpenemsError.OpenemsNamedException

Description copied from interface: AppCenterMetadata

Sends a request if the key can be applied to the given edge and app id.

Specified by:

sendIsKeyApplicable in interface AppCenterMetadata

Parameters:

key - the key to be validated

edgeId - the edge the app gets installed

appId - the app that gets installed

Returns:

the result as a JsonObject

Throws:

OpenemsError.OpenemsNamedException - on error

sendAddInstallAppInstanceHistory

public void sendAddInstallAppInstanceHistory(String key,
 String edgeId,
 String appId,
 UUID instanceId,
 String userId)
                                      throws OpenemsError.OpenemsNamedException

Description copied from interface: AppCenterMetadata.EdgeData

Sends a request to add a install app history entry.

Specified by:

sendAddInstallAppInstanceHistory in interface AppCenterMetadata.EdgeData

Parameters:

key - the key that the app gets installed with

edgeId - the edge the app gets installed on

appId - the app that gets installed

instanceId - the instanceId of the installed app

userId - the user who added the instance

Throws:

OpenemsError.OpenemsNamedException - on error

sendAddDeinstallAppInstanceHistory

public void sendAddDeinstallAppInstanceHistory(String edgeId,
 String appId,
 UUID instanceId,
 String userId)
                                        throws OpenemsError.OpenemsNamedException

Description copied from interface: AppCenterMetadata.EdgeData

Sends a request to add a deinstall history entry.

Specified by:

sendAddDeinstallAppInstanceHistory in interface AppCenterMetadata.EdgeData

Parameters:

edgeId - the edge the instance gets removed

appId - the id of the app

instanceId - the instanceId of the removed instance

userId - the user who removed the instance

Throws:

OpenemsError.OpenemsNamedException - on error

sendAddRegisterKeyHistory

public void sendAddRegisterKeyHistory(String edgeId,
 String appId,
 String key,
 User user)
                               throws OpenemsError.OpenemsNamedException

Description copied from interface: AppCenterMetadata.UiData

Sends a request to register a key.

Specified by:

sendAddRegisterKeyHistory in interface AppCenterMetadata.UiData

Parameters:

edgeId - the edge the key gets registered to

appId - the appId that gets registered

key - the key to register to the app

user - the user who added the registration

Throws:

OpenemsError.OpenemsNamedException - on error

sendAddUnregisterKeyHistory

public void sendAddUnregisterKeyHistory(String edgeId,
 String appId,
 String key,
 User user)
                                 throws OpenemsError.OpenemsNamedException

Description copied from interface: AppCenterMetadata.UiData

Sends a request to unregister a key.

Specified by:

sendAddUnregisterKeyHistory in interface AppCenterMetadata.UiData

Parameters:

edgeId - the edge

appId - the id of the app

key - the key

user - the user who removed the registration

Throws:

OpenemsError.OpenemsNamedException - on error

sendGetRegisteredKeys

public com.google.gson.JsonArray sendGetRegisteredKeys(String edgeId,
 String appId)
                                                throws OpenemsError.OpenemsNamedException

Description copied from interface: AppCenterMetadata.UiData

Sends a request to get all registered keys to the given edge and app.

Specified by:

sendGetRegisteredKeys in interface AppCenterMetadata.UiData

Parameters:

edgeId - the edge the registered key can be applied on

appId - the app of the registed key

Returns:

the result as a JsonObject

Throws:

OpenemsError.OpenemsNamedException - on error

sendGetPossibleApps

public com.google.gson.JsonArray sendGetPossibleApps(String key,
 String edgeId)
                                              throws OpenemsError.OpenemsNamedException

Description copied from interface: AppCenterMetadata

Sends a request to get all apps that can be installed with the given key.

Specified by:

sendGetPossibleApps in interface AppCenterMetadata

Parameters:

key - the apps of the key

edgeId - the apps on which edge

Returns:

the bundles and their apps

Throws:

OpenemsError.OpenemsNamedException - on error

sendGetInstalledApps

public com.google.gson.JsonObject sendGetInstalledApps(String edgeId)
                                                throws OpenemsError.OpenemsNamedException

Description copied from interface: AppCenterMetadata.EdgeData

Sends a request to get all installed apps on the edge that are logged in the backend these apps may not be actually on the edge.

Specified by:

sendGetInstalledApps in interface AppCenterMetadata.EdgeData

Parameters:

edgeId - the apps on which edge

Returns:

the installed apps

Throws:

OpenemsError.OpenemsNamedException - on error

getSuppliableKey

public String getSuppliableKey(User user,
 String edgeId,
 String appId)
                        throws OpenemsError.OpenemsNamedException

Description copied from interface: AppCenterMetadata.UiData

Gets a key that can be supplied to the installation of the given app.

Specified by:

getSuppliableKey in interface AppCenterMetadata.UiData

Parameters:

user - the requested user

edgeId - the edge to install the app on

appId - the app to install

Returns:

the key or null if none can be supplied

Throws:

OpenemsError.OpenemsNamedException - on error

isAppFree

public boolean isAppFree(User user,
 String appId)
                  throws OpenemsError.OpenemsNamedException

Description copied from interface: AppCenterMetadata.UiData

Gets if the given app is free.

Specified by:

isAppFree in interface AppCenterMetadata.UiData

Parameters:

user - the requested user

appId - the id of the app

Returns:

true if the app is free

Throws:

OpenemsError.OpenemsNamedException - on error

getUserAlertingSettings

public UserAlertingSettings getUserAlertingSettings(String edgeId,
 String userId)
                                             throws OpenemsException

Description copied from interface: Metadata

Gets the alerting settings for given edge id and userId.

Specified by:

getUserAlertingSettings in interface Metadata

Parameters:

edgeId - the Edge ID

userId - the User ID

Returns:

List of UserAlertingSettings

Throws:

OpenemsException - on error

getUserAlertingSettings

public List<UserAlertingSettings> getUserAlertingSettings(String edgeId)
                                                   throws OpenemsException

Description copied from interface: Metadata

Gets all the alerting settings for given edge id.

Specified by:

getUserAlertingSettings in interface Metadata

Parameters:

edgeId - the Edge ID

Returns:

List of UserAlertingSettings

Throws:

OpenemsException - on error

getEdgeOfflineAlertingSettings

public List<OfflineEdgeAlertingSetting> getEdgeOfflineAlertingSettings(String edgeId)
                                                                throws OpenemsException

Description copied from interface: Metadata

Gets all the offline-edge-alerting settings for given edge id.

Specified by:

getEdgeOfflineAlertingSettings in interface Metadata

Parameters:

edgeId - the Edge ID

Returns:

List of OfflineEdgeAlertingSetting

Throws:

OpenemsException - on error

getSumStateAlertingSettings

public List<SumStateAlertingSetting> getSumStateAlertingSettings(String edgeId)
                                                          throws OpenemsException

Description copied from interface: Metadata

Gets all the sumState-alerting settings for given edge id.

Specified by:

getSumStateAlertingSettings in interface Metadata

Parameters:

edgeId - the Edge ID

Returns:

List of SumStateAlertingSetting

Throws:

OpenemsException - on error

setUserAlertingSettings

public void setUserAlertingSettings(User user,
 String edgeId,
 List<UserAlertingSettings> settings)
                             throws OpenemsException

Description copied from interface: Metadata

Sets the alerting settings for the given list of users.

Specified by:

setUserAlertingSettings in interface Metadata

Parameters:

user - User the current user

edgeId - the Edge-ID

settings - list of updated UserAlertingSettings

Throws:

OpenemsException - on error

getPageDevice

public List<GetEdgesResponse.EdgeMetadata> getPageDevice(User user,
 GetEdgesRequest.PaginationOptions paginationOptions)
                                                  throws OpenemsError.OpenemsNamedException

Description copied from interface: Metadata

Gets a map of Edge-IDs with the role of the given user.

Specified by:

getPageDevice in interface Metadata

Parameters:

user - User the current user

paginationOptions - the options of the requesting page

Returns:

the role to the Edge-IDs

Throws:

OpenemsError.OpenemsNamedException - on error

getEdgeMetadataForUser

public GetEdgesResponse.EdgeMetadata getEdgeMetadataForUser(User user,
 String edgeId)
                                                     throws OpenemsError.OpenemsNamedException

Description copied from interface: Metadata

Gets the Role for a edge of the current user.

Specified by:

getEdgeMetadataForUser in interface Metadata

Parameters:

user - User the current user

edgeId - the Edge-ID

Returns:

the role to the edge

Throws:

OpenemsError.OpenemsNamedException - on error

getSumState

public Optional<Level> getSumState(String edgeId)

Description copied from interface: Metadata

Get the SumState of the edge with the given edgeId.

Specified by:

getSumState in interface Metadata

Parameters:

edgeId - to search for

Returns:

sumState as Optional of Level

updateUserSettings

public void updateUserSettings(User user,
 com.google.gson.JsonObject settings)
                        throws OpenemsError.OpenemsNamedException

Description copied from interface: Metadata

Updates the user settings.

Specified by:

updateUserSettings in interface Metadata

Parameters:

user - the user

settings - the user settings

Throws:

OpenemsError.OpenemsNamedException - on error

debugLog

public String debugLog()

Description copied from interface: DebugLoggable

Gets some output that is suitable for a continuous Debug log.

Specified by:

debugLog in interface DebugLoggable

Returns:

the debug log output; null for no log

debugMetrics

public Map<String,com.google.gson.JsonElement> debugMetrics()

Description copied from interface: DebugLoggable

Gets some output that is suitable for a debug metrics to write down as Timedata.

Specified by:

debugMetrics in interface DebugLoggable

Returns:

the key value entries to write down; null or emptyMap for no metrics