From f3ef77a445a992ba4132b3b9a2a135caa032d857 Mon Sep 17 00:00:00 2001 From: dkovalenkoI <137103092+dkovalenkoI@users.noreply.github.com> Date: Wed, 2 Aug 2023 12:26:51 -0700 Subject: [PATCH] Add GPG documentation and modify plugin to sign jar (#45) * AT-1467 add GPG documentation and modify plugin to sign jar only if deploy profile enabled * AT-1467 modify git actions to enable deploy profile * AT-1469 remove log configuration and add example for debug * AT-1469 modify imports and add additional information for tracing the logs information --- .github/workflows/maven.yml | 2 +- .github/workflows/release.yml | 2 +- README.md | 75 +++++++++++++++++++ jdbc/pom.xml | 36 +++++---- .../timestream/jdbc/TimestreamDataSource.java | 8 -- .../timestream/jdbc/TimestreamDriver.java | 14 ---- 6 files changed, 100 insertions(+), 37 deletions(-) diff --git a/.github/workflows/maven.yml b/.github/workflows/maven.yml index 129837a..a72bc09 100644 --- a/.github/workflows/maven.yml +++ b/.github/workflows/maven.yml @@ -21,7 +21,7 @@ jobs: with: java-version: 1.8 - name: Build with Maven - run: mvn -B package --file pom.xml + run: mvn -B package --file pom.xml -Pdeploy - name: Upload JARs uses: actions/upload-artifact@v2 with: diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml index 8a02f07..bfea01e 100644 --- a/.github/workflows/release.yml +++ b/.github/workflows/release.yml @@ -21,7 +21,7 @@ jobs: with: java-version: 1.8 - name: Build with Maven - run: mvn -B package --file pom.xml + run: mvn -B package --file pom.xml -Pdeploy - name: Upload JARs to release uses: AButler/upload-release-assets@v2.0 with: diff --git a/README.md b/README.md index 1a358e6..aed3159 100644 --- a/README.md +++ b/README.md @@ -399,6 +399,7 @@ Upon completion, the page will be redirected back to the `Identity providers` pa ### Building the fully shaded JAR With All Dependencies Shaded Except SLF4J (amazon-timestream-jdbc-\-jar-with-all-dependencies.jar) To build a fully shaded JAR, comment out the following two lines in the pom file in the [/jdbc/pom.xml](/jdbc/pom.xml) then run `mvn install`. +#### To build the signed jar the following maven profile should be used: `mvn clean install -Ddeploy`. ```xml system @@ -454,6 +455,80 @@ To use the JAR with no dependencies in a Java application, the following require ### Building and using the Javadoc JAR to extract the Javadoc HTML files (amazon-timestream-jdbc-\-javadoc.jar) Javadoc JAR builds with `mvn install` alongside the other JAR files. To extract the Javadoc HTML files, use the following command: `jar -xvf amazon-timestream-jdbc-1.0.0-javadoc.jar` +### GPG Installation +For building signed jar before executing: `mvn clean install -Pdeploy` the following setup should be done +1. Download and install GPG https://gnupg.org/download/ +2. Generate new key: + For GPG version 2.1.17 or greater: `gpg --full-generate-key` + For GPG version lower than 2.1.17: `gpg --default-new-key-algo rsa4096 --gen-key` +3. Export GPG TTY: `export GPG_TTY=$(tty)` + +### Debug with BI tools +#### DBeaver +1. Search `dbeaver.ini` file - It should be in the home DBeaver directory +2. Open `dbeaver.ini` file and add line `-Ddbeaver.jdbc.trace=true` to the end of the file +3. Restart DBeaver Application +4. Add driver and Connect to your timestream database. +5. In DBeaver `Workspace` go to `.metadata` folder +6. File `jdbc-api-trace.log` contains all JDBC API invocations and all queries with results. + +##### The log location Mac example +/Library/DBeaverData/workspace6/.metadata/dbeaver-debug.log + +#### Log example +2023-07-24 14:53:57.819 - Initializing the client. +2023-07-24 14:53:57.819 - Creating an AWSStaticCredentialsProvider. +2023-07-24 14:53:58.375 - Execution context opened (Timestream; Metadata; 1) +2023-07-24 14:53:58.377 - Initializing the client. +2023-07-24 14:53:58.377 - Creating an AWSStaticCredentialsProvider. + +#### DbVisualizer +To enable debug mode, the following steps should be done: +1. Open `Tools -> Debug Window` +2. Open the `Debug Log` tab +3. Enable the `Debug DbVisualizer` checkbox + +##### The log file location +`$HOME/.dbvis/sqllogs folder with the .dson extension` + +#### Tableau Desktop +To enable debug mode need to run Tableau Desktop with -DLogLevel=debug flag +More details on the official [documentation](https://kb.tableau.com/articles/howto/how-to-create-tableau-desktop-debug-logs) + +#### Java Application +Need to change the log level to `DEBUG` or `FINE`. + +#### For Spring based application +The log level can be modified by changing application.properties + +`logging.level.root=DEBUG` +`logging.level.software.amazon.timestream.jdbc=FINE` + +#### By VM arguments +1. Create file `logging.properties` +2. Add line `software.amazon.timestream.jdbc=FINE` to the `logging.properties` file +3. Run application with arguments `-Djava.util.logging.config.file="logging.properties"` + +#### Programmatically in the code +`public static void setLogLevel(Level level) { +Logger rootLogger = LogManager.getLogManager().getLogger(""); + Handler[] handlers = rootLogger.getHandlers(); + rootLogger.setLevel(level); + for (Handler handler : handlers) { + if(handler instanceof FileHandler) { + handler.setLevel(newLvl); + } + }` +}` + +#### Logs example + +21:23:51.255 [main] INFO software.amazon.timestream.jdbc.TimestreamConnection - Initializing the client. +21:23:51.256 [main] INFO software.amazon.timestream.jdbc.TimestreamConnection - Creating an AWSStaticCredentialsProvider. +Jul. 25, 2023 9:23:51 P.M. com.amazonaws.internal.DefaultServiceEndpointBuilder getServiceEndpoint +INFO: {query.timestream, us-west-2} was not found in region metadata, trying to construct an endpoint using the standard pattern for this region: region +21:23:53.191 [main] INFO software.amazon.timestream.jdbc.TimestreamStatement - Query ID: SOME_ID + ### Known Issues 1. Timestream does not support fully qualified table names. 2. Timestream does not support the queries that contain ":" in the column aliases. Tools like Tableau may not work as expected. diff --git a/jdbc/pom.xml b/jdbc/pom.xml index e222d5b..f774e2a 100644 --- a/jdbc/pom.xml +++ b/jdbc/pom.xml @@ -78,6 +78,29 @@ 1.11.872 + + + deploy + + + + org.apache.maven.plugins + maven-gpg-plugin + + + sign-artifacts + verify + + sign + + + + + + + + + com.amazonaws @@ -336,19 +359,6 @@ - - org.apache.maven.plugins - maven-gpg-plugin - - - sign-artifacts - verify - - sign - - - - org.sonatype.plugins nexus-staging-maven-plugin diff --git a/jdbc/src/main/java/software/amazon/timestream/jdbc/TimestreamDataSource.java b/jdbc/src/main/java/software/amazon/timestream/jdbc/TimestreamDataSource.java index b53b6d7..bb28eb1 100644 --- a/jdbc/src/main/java/software/amazon/timestream/jdbc/TimestreamDataSource.java +++ b/jdbc/src/main/java/software/amazon/timestream/jdbc/TimestreamDataSource.java @@ -17,7 +17,6 @@ import com.amazonaws.ClientConfiguration; import com.google.common.annotations.VisibleForTesting; -import org.slf4j.bridge.SLF4JBridgeHandler; import javax.sql.ConnectionEvent; import javax.sql.ConnectionEventListener; @@ -30,7 +29,6 @@ import java.util.List; import java.util.Map; import java.util.Properties; -import java.util.logging.Level; import java.util.logging.Logger; /** @@ -42,12 +40,6 @@ public class TimestreamDataSource implements javax.sql.DataSource, private static final Logger LOGGER = Logger .getLogger("TimestreamDataSource"); - static { - SLF4JBridgeHandler.removeHandlersForRootLogger(); - SLF4JBridgeHandler.install(); - LOGGER.setLevel(Level.FINE); - } - @VisibleForTesting final ClientConfiguration clientConfiguration = new ClientConfiguration() .withUserAgentSuffix( diff --git a/jdbc/src/main/java/software/amazon/timestream/jdbc/TimestreamDriver.java b/jdbc/src/main/java/software/amazon/timestream/jdbc/TimestreamDriver.java index 0d8e176..7cf838a 100644 --- a/jdbc/src/main/java/software/amazon/timestream/jdbc/TimestreamDriver.java +++ b/jdbc/src/main/java/software/amazon/timestream/jdbc/TimestreamDriver.java @@ -17,18 +17,12 @@ import com.amazonaws.ClientConfiguration; import com.google.common.base.Strings; -import org.slf4j.bridge.SLF4JBridgeHandler; -import java.io.BufferedReader; import java.io.InputStream; -import java.io.InputStreamReader; -import java.lang.management.ManagementFactory; -import java.nio.charset.StandardCharsets; import java.sql.DriverManager; import java.sql.DriverPropertyInfo; import java.sql.SQLException; import java.util.Properties; -import java.util.logging.Level; import java.util.logging.Logger; import java.util.stream.Stream; @@ -45,14 +39,6 @@ public class TimestreamDriver implements java.sql.Driver { static final String APPLICATION_NAME; static { - // We want to use SLF4J as the logging framework, so install the bridge for it. - SLF4JBridgeHandler.removeHandlersForRootLogger(); - SLF4JBridgeHandler.install(); - - // Enable only >= FINE logs in the JUL Logger since we want to control things via SLF4J. JUL Logger will filter out - // messages before it gets to SLF4J if it set to a restrictive level. - LOGGER.setLevel(Level.FINE); - APPLICATION_NAME = getApplicationName(); APP_NAME_SUFFIX = " [" + APPLICATION_NAME + "]"; LOGGER.finer("Name of the application using the driver: " + APP_NAME_SUFFIX);