forked from eclipse-hono/hono
-
Notifications
You must be signed in to change notification settings - Fork 2
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
[eclipse-hono#565] Implement protocol connection events
Showing
6 changed files
with
316 additions
and
30 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
49 changes: 49 additions & 0 deletions
49
service-base/src/main/java/org/eclipse/hono/service/monitoring/ConnectionEventProducer.java
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,49 @@ | ||
| /** | ||
| * Copyright (c) 2018 Contributors to the Eclipse Foundation | ||
| * | ||
| * See the NOTICE file(s) distributed with this work for additional | ||
| * information regarding copyright ownership. | ||
| * | ||
| * This program and the accompanying materials are made available under the | ||
| * terms of the Eclipse Public License 1.0 which is available at | ||
| * https://www.eclipse.org/legal/epl-v10.html | ||
| * | ||
| * SPDX-License-Identifier: EPL-1.0 | ||
| */ | ||
| package org.eclipse.hono.service.monitoring; | ||
|
|
||
| import org.eclipse.hono.service.auth.device.Device; | ||
|
|
||
| /** | ||
| * Produces connection events. | ||
| * <p> | ||
| * The interface is intended to be implemented by setups which are interested in receiving technical connection events. | ||
| * Which might not make sense for all protocols adapters. But mostly for connection oriented ones like MQTT or AMQP 1.0. | ||
| * <p> | ||
| * The protocol adapters may call {@link #connected(String, Device)} and {@link #disconnected(String, Device)} as they | ||
| * see fit. The whole process is a "best effort" process and intended to be used for monitoring/debugging. | ||
| * <p> | ||
| * When a protocol adapter calls into this producer it must provide some kind of connection ID, which might have a | ||
| * different meaning for different protocol adapters. This should be as identifiable as possible but there is no | ||
| * requirement for this to be unique. However for each connection the protocol adapter must call | ||
| * {@link #disconnected(String, Device)} with the same information as it called {@link #connected(String, Device)}. | ||
| */ | ||
| public interface ConnectionEventProducer { | ||
|
|
||
| /** | ||
| * Produce an event for a new connection. | ||
| * | ||
| * @param connectionIdentifier The ID of the connection which connected. | ||
| * @param authenticatedDevice The optional authenticated device associated with the connection. May be {@code null}. | ||
| */ | ||
| public void connected(String connectionIdentifier, Device authenticatedDevice); | ||
|
|
||
| /** | ||
| * Produce an event for a closed connection. | ||
| * | ||
| * @param connectionIdentifier The ID of the connection which disconnected. | ||
| * @param authenticatedDevice The optional authenticated device associated with the connection. May be {@code null}. | ||
| */ | ||
| public void disconnected(String connectionIdentifier, Device authenticatedDevice); | ||
|
|
||
| } |
87 changes: 87 additions & 0 deletions
87
...ase/src/main/java/org/eclipse/hono/service/monitoring/LoggingConnectionEventProducer.java
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,87 @@ | ||
| /** | ||
| * Copyright (c) 2018 Contributors to the Eclipse Foundation | ||
| * | ||
| * See the NOTICE file(s) distributed with this work for additional | ||
| * information regarding copyright ownership. | ||
| * | ||
| * This program and the accompanying materials are made available under the | ||
| * terms of the Eclipse Public License 1.0 which is available at | ||
| * https://www.eclipse.org/legal/epl-v10.html | ||
| * | ||
| * SPDX-License-Identifier: EPL-1.0 | ||
| */ | ||
| package org.eclipse.hono.service.monitoring; | ||
|
|
||
| import static java.lang.invoke.MethodType.methodType; | ||
|
|
||
| import java.lang.invoke.MethodHandle; | ||
| import java.lang.invoke.MethodHandles; | ||
|
|
||
| import org.eclipse.hono.service.auth.device.Device; | ||
| import org.slf4j.Logger; | ||
| import org.slf4j.LoggerFactory; | ||
| import org.slf4j.event.Level; | ||
|
|
||
| /** | ||
| * A logging only implementation. | ||
| */ | ||
| public class LoggingConnectionEventProducer implements ConnectionEventProducer { | ||
|
|
||
| private static final Logger logger = LoggerFactory.getLogger(LoggingConnectionEventProducer.class); | ||
|
|
||
| private final MethodHandle handle; | ||
|
|
||
| /** | ||
| * Create a new instance with the default log level ({@link Level#INFO}). | ||
| */ | ||
| public LoggingConnectionEventProducer() { | ||
| this(null); | ||
| } | ||
|
|
||
| /** | ||
| * Create a new instance with the provided log level. | ||
| * | ||
| * @param level The provided log level to use, may be {@code null} in which case {@link Level#INFO} will be used. | ||
| */ | ||
| public LoggingConnectionEventProducer(Level level) { | ||
| if (level == null) { | ||
| level = Level.INFO; | ||
| } | ||
| this.handle = loggerMethod(level.name().toLowerCase()).bindTo(logger); | ||
| } | ||
|
|
||
| private MethodHandle loggerMethod(final String methodName) { | ||
| try { | ||
| return MethodHandles.lookup() | ||
| .findVirtual(Logger.class, | ||
| methodName, | ||
| methodType(void.class, String.class, Object.class, Object.class)); | ||
| } catch (final NoSuchMethodException | IllegalAccessException e) { | ||
| throw new RuntimeException("Failed to set up logger", e); | ||
| } | ||
| } | ||
|
|
||
| private void log(final String message, final Object connectionIdentifier, final Object authenticatedDevice) { | ||
| try { | ||
| logInternal(message, connectionIdentifier, authenticatedDevice); | ||
| } catch (final Throwable e) { | ||
| // we don't want a log message to fail anything | ||
| } | ||
| } | ||
|
|
||
| void logInternal(final String message, final Object connectionIdentifier, final Object authenticatedDevice) | ||
| throws Throwable { | ||
| this.handle.invokeExact(message, connectionIdentifier, authenticatedDevice); | ||
| } | ||
|
|
||
| @Override | ||
| public void connected(final String connectionIdentifier, final Device authenticatedDevice) { | ||
| log(" Connected - ID: {}, Device: {}", connectionIdentifier, authenticatedDevice); | ||
| } | ||
|
|
||
| @Override | ||
| public void disconnected(final String connectionIdentifier, final Device authenticatedDevice) { | ||
| log("Disconnected - ID: {}, Device: {}", connectionIdentifier, authenticatedDevice); | ||
| } | ||
|
|
||
| } |
45 changes: 45 additions & 0 deletions
45
...st/java/org/eclipse/hono/service/monitoring/LoggingConnectionEventProducerLevelsTest.java
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,45 @@ | ||
| /** | ||
| * Copyright (c) 2018 Contributors to the Eclipse Foundation | ||
| * | ||
| * See the NOTICE file(s) distributed with this work for additional | ||
| * information regarding copyright ownership. | ||
| * | ||
| * This program and the accompanying materials are made available under the | ||
| * terms of the Eclipse Public License 1.0 which is available at | ||
| * https://www.eclipse.org/legal/epl-v10.html | ||
| * | ||
| * SPDX-License-Identifier: EPL-1.0 | ||
| */ | ||
|
|
||
| package org.eclipse.hono.service.monitoring; | ||
|
|
||
| import org.eclipse.hono.service.auth.device.Device; | ||
| import org.junit.Test; | ||
| import org.junit.runner.RunWith; | ||
| import org.junit.runners.Parameterized; | ||
| import org.junit.runners.Parameterized.Parameters; | ||
| import org.slf4j.event.Level; | ||
|
|
||
| /** | ||
| * Test if all levels can be used for logging. | ||
| */ | ||
| @RunWith(Parameterized.class) | ||
| public class LoggingConnectionEventProducerLevelsTest { | ||
|
|
||
| @Parameters | ||
| public static Level[] levels() { | ||
| return Level.values(); | ||
| } | ||
|
|
||
| private Level level; | ||
|
|
||
| public LoggingConnectionEventProducerLevelsTest(Level level) { | ||
| this.level = level; | ||
| } | ||
|
|
||
| @Test | ||
| public void testLevel() throws Throwable { | ||
| final LoggingConnectionEventProducer l = new LoggingConnectionEventProducer(this.level); | ||
| l.logInternal("Foo", "bar", new Device("DEFAULT_TENANT", "device1")); | ||
| } | ||
| } |