Skip to content

Commit 1d52796

Browse files
author
kasemir
committed
Review PVA log levels
See PVASettings.logger for intended log level usage
1 parent 3e1d310 commit 1d52796

15 files changed

+114
-50
lines changed

‎core/pva/serverdemo‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,8 +4,8 @@ JAR=`echo target/core-pva*.jar`
44
if [ -r "$JAR" ]
55
then
66
# Echo use jar file
7-
java -cp $JAR org.epics.pva.server.ServerDemo
7+
java -cp $JAR org.epics.pva.server.ServerDemo "$@"
88
else
99
# Use build output
10-
java -cp target/classes org.epics.pva.server.ServerDemo
10+
java -cp target/classes org.epics.pva.server.ServerDemo "$@"
1111
fi

‎core/pva/src/main/java/org/epics/pva/PVASettings.java‎

Lines changed: 12 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
/*******************************************************************************
2-
* Copyright (c) 2019-2023 Oak Ridge National Laboratory.
2+
* Copyright (c) 2019-2025 Oak Ridge National Laboratory.
33
* All rights reserved. This program and the accompanying materials
44
* are made available under the terms of the Eclipse Public License v1.0
55
* which accompanies this distribution, and is available at
@@ -18,10 +18,19 @@
1818
*
1919
* @author Kay Kasemir
2020
*/
21-
@SuppressWarnings("nls")
2221
public class PVASettings
2322
{
24-
/** Common logger */
23+
/** Common logger
24+
*
25+
* Usage of levels:
26+
* <ul>
27+
* <li>INFO - Not used?
28+
* <li>CONFIG - Log value of configuration settings
29+
* <li>FINE - Log Search, reply, connection, auth, put/get/monitor
30+
* <li>FINER - Log detail of sockets, messages
31+
* <li>FINEST - Hexdump of each packet
32+
* </ul>
33+
*/
2534
public static final Logger logger = Logger.getLogger(PVASettings.class.getPackage().getName());
2635

2736
/** Address list.

‎core/pva/src/main/java/org/epics/pva/client/ChannelSearch.java‎

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,6 @@
2929
import org.epics.pva.common.AddressInfo;
3030
import org.epics.pva.common.RequestEncoder;
3131
import org.epics.pva.common.SearchRequest;
32-
import org.epics.pva.data.Hexdump;
3332
import org.epics.pva.data.PVAString;
3433

3534
/** Handler for search requests
@@ -65,7 +64,6 @@
6564
*
6665
* @author Kay Kasemir
6766
*/
68-
@SuppressWarnings("nls")
6967
class ChannelSearch
7068
{
7169
/** Basic search period is one second */
@@ -518,7 +516,7 @@ private void sendSearch(final int seq, final Collection<SearchRequest.Channel> c
518516
try
519517
{
520518
logger.log(Level.FINER, () -> "Sending search to UDP " + addr + " (unicast), " +
521-
"response addr " + response + "\n" + Hexdump.toHexdump(send_buffer));
519+
"response addr " + response);
522520
udp.send(send_buffer, addr);
523521
}
524522
catch (Exception ex)
@@ -536,7 +534,7 @@ private void sendSearch(final int seq, final Collection<SearchRequest.Channel> c
536534
try
537535
{
538536
logger.log(Level.FINER, () -> "Sending search to UDP " + addr + " (broadcast/multicast), " +
539-
"response addr " + response + "\n" + Hexdump.toHexdump(send_buffer));
537+
"response addr " + response);
540538
udp.send(send_buffer, addr);
541539
}
542540
catch (Exception ex)

‎core/pva/src/main/java/org/epics/pva/client/ClientTCPHandler.java‎

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,6 @@
3939
*
4040
* @author Kay Kasemir
4141
*/
42-
@SuppressWarnings("nls")
4342
class ClientTCPHandler extends TCPHandler
4443
{
4544
private static final CommandHandlers<ClientTCPHandler> handlers =
@@ -112,7 +111,7 @@ class ClientTCPHandler extends TCPHandler
112111
public ClientTCPHandler(final PVAClient client, final InetSocketAddress address, final Guid guid, final boolean tls) throws Exception
113112
{
114113
super(true);
115-
logger.log(Level.FINE, () -> "TCPHandler " + (tls ? "(TLS) " : "") + guid + " for " + address + " created ============================");
114+
logger.log(Level.FINER, () -> "TCPHandler " + (tls ? "(TLS) " : "") + guid + " for " + address + " created ============================");
116115
this.server_address = address;
117116
this.tls = tls;
118117
this.client = client;

‎core/pva/src/main/java/org/epics/pva/client/ClientUDPHandler.java‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,6 @@
3737
/** Sends and receives search replies, monitors beacons
3838
* @author Kay Kasemir
3939
*/
40-
@SuppressWarnings("nls")
4140
class ClientUDPHandler extends UDPHandler
4241
{
4342
@FunctionalInterface
@@ -122,7 +121,7 @@ public ClientUDPHandler(final BeaconHandler beacon_handler,
122121
ipV6Msg = "";
123122
}
124123
String logMsg = String.format("Awaiting search replies on UDP %s%s and beacons on %s", udp_localaddr4, ipV6Msg, Network.getLocalAddress(udp_beacon));
125-
logger.log(Level.FINE, logMsg);
124+
logger.log(Level.CONFIG, logMsg);
126125
}
127126

128127
/** @param target Address to which message will be sent
@@ -135,6 +134,7 @@ InetSocketAddress getResponseAddress(final AddressInfo target)
135134

136135
public void send(final ByteBuffer buffer, final AddressInfo info) throws Exception
137136
{
137+
logger.log(Level.FINEST, () -> "Sending UDP to " + info.getAddress() + "\n" + Hexdump.toHexdump(buffer));
138138
// synchronized (udp_search)?
139139
// Not necessary based on Javadoc for send(),
140140
// but in case we set the multicast IF & TTL

‎core/pva/src/main/java/org/epics/pva/client/PVAClientMain.java‎

Lines changed: 6 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,6 @@
3333
*
3434
* @author Kay Kasemir
3535
*/
36-
@SuppressWarnings("nls")
3736
public class PVAClientMain
3837
{
3938
private static double seconds = 5.0;
@@ -100,8 +99,8 @@ private static void info(final List<String> names) throws Exception
10099
final PVAChannel pv = iter.next();
101100
if (pv.getState() == ClientChannelState.CONNECTED)
102101
{
103-
PVASettings.logger.log(Level.INFO, "Server X509 Name: " + pv.getTCP().getServerX509Name());
104-
PVASettings.logger.log(Level.INFO, "Client X509 Name: " + pv.getTCP().getClientX509Name());
102+
PVASettings.logger.log(Level.FINE, "Server X509 Name: " + pv.getTCP().getServerX509Name());
103+
PVASettings.logger.log(Level.FINE, "Client X509 Name: " + pv.getTCP().getClientX509Name());
105104

106105
final PVAData data = pv.info(request).get(timeout_ms, TimeUnit.MILLISECONDS);
107106
System.out.println(pv.getName() + " = " + data.formatType());
@@ -145,8 +144,8 @@ private static void get(final List<String> names) throws Exception
145144
final PVAChannel pv = iter.next();
146145
if (pv.getState() == ClientChannelState.CONNECTED)
147146
{
148-
PVASettings.logger.log(Level.INFO, "Server X509 Name: " + pv.getTCP().getServerX509Name());
149-
PVASettings.logger.log(Level.INFO, "Client X509 Name: " + pv.getTCP().getClientX509Name());
147+
PVASettings.logger.log(Level.FINE, "Server X509 Name: " + pv.getTCP().getServerX509Name());
148+
PVASettings.logger.log(Level.FINE, "Client X509 Name: " + pv.getTCP().getClientX509Name());
150149

151150
final PVAData data = pv.read(request).get(timeout_ms, TimeUnit.MILLISECONDS);
152151
System.out.println(pv.getName() + " = " + data);
@@ -191,8 +190,8 @@ private static void monitor(final List<String> names) throws Exception
191190
{
192191
try
193192
{
194-
PVASettings.logger.log(Level.INFO, "Server X509 Name: " + ch.getTCP().getServerX509Name());
195-
PVASettings.logger.log(Level.INFO, "Client X509 Name: " + ch.getTCP().getClientX509Name());
193+
PVASettings.logger.log(Level.FINE, "Server X509 Name: " + ch.getTCP().getServerX509Name());
194+
PVASettings.logger.log(Level.FINE, "Client X509 Name: " + ch.getTCP().getClientX509Name());
196195
ch.subscribe(request, listener);
197196
}
198197
catch (Exception ex)

‎core/pva/src/main/java/org/epics/pva/common/CertificateStatusMonitor.java‎

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -115,9 +115,10 @@ private void handleConnection(final PVAChannel channel, final ClientChannelState
115115

116116
private void handleMonitor(final PVAChannel channel, final BitSet changes, final BitSet overruns, final PVAStructure data)
117117
{
118-
// TODO also check string ocsp_certified_until Mon Sep 22 19:37:25 2025 UTC?
119-
// TODO Can those be time_t secondsPastEpoch?
118+
logger.log(Level.FINE, () -> "Received " + channel.getName() + " = " + data);
119+
120120
// Decode overall status enum, VALID or not?
121+
// TODO Check ocsp_response
121122
final PVAEnum value = PVAEnum.fromStructure(data.get("value"));
122123
if (value != null)
123124
{

‎core/pva/src/main/java/org/epics/pva/common/TCPHandler.java‎

Lines changed: 6 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,6 @@
3939
*
4040
* @author Kay Kasemir
4141
*/
42-
@SuppressWarnings("nls")
4342
abstract public class TCPHandler
4443
{
4544
/** Protocol version used by the PVA server
@@ -233,7 +232,7 @@ private Void sender()
233232
*/
234233
protected void send(final ByteBuffer buffer) throws Exception
235234
{
236-
logger.log(Level.FINER, () -> Thread.currentThread().getName() + " sends:\n" + Hexdump.toHexdump(buffer));
235+
logger.log(Level.FINEST, () -> Thread.currentThread().getName() + " sends:\n" + Hexdump.toHexdump(buffer));
237236

238237
// Original AbstractCodec.send() mentions
239238
// Microsoft KB article KB823764:
@@ -276,7 +275,7 @@ private Void receiver()
276275
// Listen on the connection
277276
Thread.currentThread().setName("TCP receiver " + socket.getLocalSocketAddress());
278277
logger.log(Level.FINER, () -> Thread.currentThread().getName() + " started for " + socket.getRemoteSocketAddress());
279-
logger.log(Level.FINER, "Native byte order " + receive_buffer.order());
278+
logger.log(Level.FINEST, "Native byte order " + receive_buffer.order());
280279
receive_buffer.clear();
281280
final InputStream in = socket.getInputStream();
282281
while (true)
@@ -294,15 +293,15 @@ private Void receiver()
294293
return null;
295294
}
296295
if (read > 0)
297-
logger.log(Level.FINER, () -> Thread.currentThread().getName() + ": " + read + " bytes");
296+
logger.log(Level.FINEST, () -> Thread.currentThread().getName() + ": " + read + " bytes");
298297
receive_buffer.position(receive_buffer.position() + read);
299298
// and once we get the header, it will tell
300299
// us how large the message actually is
301300
message_size = PVAHeader.checkMessageAndGetSize(receive_buffer, client_mode);
302301
}
303302
// .. then decode
304303
receive_buffer.flip();
305-
logger.log(Level.FINER, () -> Thread.currentThread().getName() + " received:\n" + Hexdump.toHexdump(receive_buffer));
304+
logger.log(Level.FINEST, () -> Thread.currentThread().getName() + " received:\n" + Hexdump.toHexdump(receive_buffer));
306305

307306
// While buffer may contain more data,
308307
// limit it to the end of this message to prevent
@@ -560,7 +559,7 @@ protected void handleApplicationMessage(final byte command, final ByteBuffer buf
560559
*/
561560
public void close(final boolean wait)
562561
{
563-
logger.log(Level.FINE, "Closing " + this);
562+
logger.log(Level.FINER, "Closing " + this);
564563

565564
// Wait until all requests are sent out
566565
submit(END_REQUEST);
@@ -585,7 +584,7 @@ public void close(final boolean wait)
585584
{
586585
logger.log(Level.WARNING, "Cannot stop receive thread", ex);
587586
}
588-
logger.log(Level.FINE, () -> this + " closed ============================");
587+
logger.log(Level.FINER, () -> this + " closed ============================");
589588
}
590589

591590
@Override

‎core/pva/src/main/java/org/epics/pva/common/UDPHandler.java‎

Lines changed: 4 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
/*******************************************************************************
2-
* Copyright (c) 2019-2022 Oak Ridge National Laboratory.
2+
* Copyright (c) 2019-2025 Oak Ridge National Laboratory.
33
* All rights reserved. This program and the accompanying materials
44
* are made available under the terms of the Eclipse Public License v1.0
55
* which accompanies this distribution, and is available at
@@ -20,7 +20,6 @@
2020
/** Base for handling UDP traffic
2121
* @author Kay Kasemir
2222
*/
23-
@SuppressWarnings("nls")
2423
abstract public class UDPHandler
2524
{
2625
/** Keep running? */
@@ -32,7 +31,7 @@ abstract public class UDPHandler
3231
*/
3332
protected void listen(final DatagramChannel udp, final ByteBuffer buffer)
3433
{
35-
logger.log(Level.FINE, "Starting " + Thread.currentThread().getName());
34+
logger.log(Level.FINER, "Starting " + Thread.currentThread().getName());
3635
final String local = Network.getLocalAddress(udp);
3736
while (running)
3837
{
@@ -45,7 +44,7 @@ protected void listen(final DatagramChannel udp, final ByteBuffer buffer)
4544

4645
// XXX Check against list of ignored addresses?
4746

48-
logger.log(Level.FINER, () -> "Received UDP from " + from + " on " + local + "\n" + Hexdump.toHexdump(buffer));
47+
logger.log(Level.FINEST, () -> "Received UDP from " + from + " on " + local + "\n" + Hexdump.toHexdump(buffer));
4948
handleMessages(from, buffer);
5049
}
5150
catch (Exception ex)
@@ -55,7 +54,7 @@ protected void listen(final DatagramChannel udp, final ByteBuffer buffer)
5554
// else: Ignore, closing
5655
}
5756
}
58-
logger.log(Level.FINE, "Exiting " + Thread.currentThread().getName());
57+
logger.log(Level.FINER, "Exiting " + Thread.currentThread().getName());
5958
}
6059

6160
/** Handle one or more reply messages

‎core/pva/src/main/java/org/epics/pva/server/CreateChannelHandler.java‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -44,7 +44,7 @@ public void handleCommand(final ServerTCPHandler tcp, final ByteBuffer buffer) t
4444
logger.log(Level.WARNING, () -> "Channel create request for unknown PV '" + name + "'");
4545
else
4646
{
47-
logger.log(Level.FINE, () -> "Channel create request '" + name + "', cid " + cid);
47+
logger.log(Level.FINE, () -> "Channel create request '" + name + "' [CID " + cid + "]");
4848
pv.addClient(tcp, cid);
4949
sendChannelCreated(tcp, pv, cid);
5050
}

0 commit comments

Comments
 (0)