├── src
    ├── main
    │   ├── resources
    │   │   └── META-INF
    │   │   │   └── services
    │   │   │       └── io.trino.spi.Plugin
    │   ├── assembly
    │   │   └── zip.xml
    │   └── java
    │   │   └── com
    │   │       └── github
    │   │           └── trino
    │   │               └── querylog
    │   │                   ├── QueryLogPlugin.java
    │   │                   ├── QueryLogListener.java
    │   │                   └── QueryLogListenerFactory.java
    └── test
    │   ├── resources
    │       ├── queryCreatedEvents.xml
    │       └── onlyQueryCreatedEvents.xml
    │   └── java
    │       └── com
    │           └── github
    │               └── trino
    │                   └── querylog
    │                       ├── QueryLogListenerFactoryTest.java
    │                       └── QueryLogListenerTest.java
├── .gitignore
├── .github
    └── workflows
    │   └── maven.yml
├── README.md
├── pom.xml
└── LICENSE


/src/main/resources/META-INF/services/io.trino.spi.Plugin:
--------------------------------------------------------------------------------
1 | com.github.trino.querylog.QueryLogPlugin


--------------------------------------------------------------------------------
/.gitignore:
--------------------------------------------------------------------------------
 1 | .idea
 2 | *.iml
 3 | *.ipr
 4 | *.iws
 5 | .idea
 6 | .DS_Store
 7 | .classpath
 8 | .settings
 9 | .project
10 | target/
11 | pom.xml.tag
12 | pom.xml.releaseBackup
13 | pom.xml.versionsBackup
14 | pom.xml.next
15 | release.properties
16 | dependency-reduced-pom.xml
17 | buildNumber.properties
18 | .mvn/timing.properties
19 | # Avoid ignoring Maven wrapper jar file (.jar files are usually ignored)
20 | !/.mvn/wrapper/maven-wrapper.jar
21 | 


--------------------------------------------------------------------------------
/src/main/assembly/zip.xml:
--------------------------------------------------------------------------------
 1 | <assembly xmlns="http://maven.apache.org/ASSEMBLY/2.0.0"
 2 |           xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
 3 |           xsi:schemaLocation="http://maven.apache.org/ASSEMBLY/2.0.0 http://maven.apache.org/xsd/assembly-2.0.0.xsd">
 4 |     <id>dist</id>
 5 |     <includeBaseDirectory>false</includeBaseDirectory>
 6 | 
 7 |     <formats>
 8 |         <format>zip</format>
 9 |     </formats>
10 |     <files>
11 |         <file>
12 |             <source>${project.build.directory}/${project.artifactId}-${project.version}.jar</source>
13 |         </file>
14 |     </files>
15 |     <dependencySets>
16 |         <dependencySet>
17 |             <scope>runtime</scope>
18 |             <excludes>
19 |                 <exclude>${project.groupId}:${project.artifactId}:jar:*</exclude>
20 |             </excludes>
21 |         </dependencySet>
22 |     </dependencySets>
23 | </assembly>
24 | 


--------------------------------------------------------------------------------
/src/test/resources/queryCreatedEvents.xml:
--------------------------------------------------------------------------------
 1 | <?xml version="1.0" encoding="UTF-8"?>
 2 | <Configuration status="warn" name="TrinoQueryLog" packages="">
 3 |     <Appenders>
 4 |         <RollingFile name="JsonRollingFile" append="false">
 5 |             <FileName>target/queryCreatedEvents.log</FileName>
 6 |             <FilePattern>target/%d{yyyy-MM-dd-hh}-%i.log</FilePattern>
 7 |             <JsonLayout charset="UTF-8" includeStacktrace="false"
 8 |                         compact="true" eventEol="true" objectMessageAsJsonObject="true"/>
 9 |             <Policies>
10 |                 <SizeBasedTriggeringPolicy size="10 MB"/>
11 |             </Policies>
12 |             <DefaultRolloverStrategy max="10"/>
13 |         </RollingFile>
14 |     </Appenders>
15 | 
16 |     <Loggers>
17 |         <Root level="INFO">
18 |             <AppenderRef ref="JsonRollingFile"/>
19 |         </Root>
20 |     </Loggers>
21 | </Configuration>


--------------------------------------------------------------------------------
/src/test/resources/onlyQueryCreatedEvents.xml:
--------------------------------------------------------------------------------
 1 | <?xml version="1.0" encoding="UTF-8"?>
 2 | <Configuration status="warn" name="TrinoQueryLog" packages="">
 3 |     <Appenders>
 4 |         <RollingFile name="JsonRollingFile" append="false">
 5 |             <FileName>target/onlyQueryCreatedEvents.log</FileName>
 6 |             <FilePattern>target/%d{yyyy-MM-dd-hh}-%i.log</FilePattern>
 7 |             <JsonLayout charset="UTF-8" includeStacktrace="false"
 8 |                         compact="true" eventEol="true" objectMessageAsJsonObject="true"/>
 9 |             <Policies>
10 |                 <SizeBasedTriggeringPolicy size="10 MB"/>
11 |             </Policies>
12 |             <DefaultRolloverStrategy max="10"/>
13 |         </RollingFile>
14 |     </Appenders>
15 | 
16 |     <Loggers>
17 |         <Root level="INFO">
18 |             <AppenderRef ref="JsonRollingFile"/>
19 |         </Root>
20 |     </Loggers>
21 | </Configuration>


--------------------------------------------------------------------------------
/src/main/java/com/github/trino/querylog/QueryLogPlugin.java:
--------------------------------------------------------------------------------
 1 | /*
 2 |  * Licensed under the Apache License, Version 2.0 (the "License");
 3 |  * you may not use this file except in compliance with the License.
 4 |  * You may obtain a copy of the License at
 5 |  *
 6 |  *     http://www.apache.org/licenses/LICENSE-2.0
 7 |  *
 8 |  * Unless required by applicable law or agreed to in writing, software
 9 |  * distributed under the License is distributed on an "AS IS" BASIS,
10 |  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
11 |  * See the License for the specific language governing permissions and
12 |  * limitations under the License.
13 |  */
14 | package com.github.trino.querylog;
15 | 
16 | import io.trino.spi.Plugin;
17 | import io.trino.spi.eventlistener.EventListenerFactory;
18 | 
19 | import java.util.Collections;
20 | 
21 | public class QueryLogPlugin implements Plugin {
22 | 
23 |     @Override
24 |     public Iterable<EventListenerFactory> getEventListenerFactories() {
25 |         return Collections.singletonList(new QueryLogListenerFactory());
26 |     }
27 | }


--------------------------------------------------------------------------------
/src/test/java/com/github/trino/querylog/QueryLogListenerFactoryTest.java:
--------------------------------------------------------------------------------
 1 | package com.github.trino.querylog;
 2 | 
 3 | import org.junit.jupiter.api.Test;
 4 | 
 5 | import java.util.HashMap;
 6 | import java.util.Map;
 7 | 
 8 | import static org.junit.jupiter.api.Assertions.assertEquals;
 9 | import static org.junit.jupiter.api.Assertions.assertThrows;
10 | 
11 | class QueryLogListenerFactoryTest {
12 | 
13 |     @Test
14 |     void getName() {
15 |         QueryLogListenerFactory listenerFactory = new QueryLogListenerFactory();
16 |         assertEquals("trino-querylog", listenerFactory.getName());
17 |     }
18 | 
19 |     @Test
20 |     void createWithoutConfigShouldThrowException() {
21 |         // Given
22 |         Map<String, String> configs = new HashMap<>();
23 |         configs.put(QueryLogListenerFactory.QUERYLOG_CONFIG_LOCATION, null);
24 |         // When
25 |         QueryLogListenerFactory listenerFactory = new QueryLogListenerFactory();
26 |         // Then
27 |         assertThrows(
28 |                 NullPointerException.class,
29 |                 () -> listenerFactory.create(configs),
30 |                 QueryLogListenerFactory.QUERYLOG_CONFIG_LOCATION + " is null"
31 |         );
32 |     }
33 | }


--------------------------------------------------------------------------------
/.github/workflows/maven.yml:
--------------------------------------------------------------------------------
 1 | # This workflow will build a Java project with Maven
 2 | # For more information see: https://help.github.com/actions/language-and-framework-guides/building-and-testing-java-with-maven
 3 | 
 4 | name: Unit Tests
 5 | 
 6 | on:
 7 |   pull_request:
 8 |   push:
 9 |     branches:
10 |       - master
11 | 
12 | jobs:
13 |   build:
14 |     runs-on: ubuntu-latest
15 |     strategy:
16 |       matrix:
17 |         java: [ 11, 14 ]
18 |     steps:
19 |     - uses: actions/checkout@v2
20 |     - uses: actions/cache@v1
21 |       with:
22 |         path: ~/.m2/repository
23 |         key: ${{ runner.os }}-maven-${{ hashFiles('**/pom.xml') }}
24 |         restore-keys: |
25 |           ${{ runner.os }}-maven-
26 |     - name: Set up JDK
27 |       uses: actions/setup-java@v1
28 |       with:
29 |         java-version: ${{ matrix.java }}
30 |     - name: Build with Maven
31 |       run: mvn -B clean test --file pom.xml
32 |   sonar:
33 |     runs-on: ubuntu-latest
34 |     steps:
35 |       - uses: actions/checkout@v2
36 |       - run: |
37 |           git fetch --prune --unshallow
38 |       - uses: actions/cache@v1
39 |         with:
40 |           path: ~/.m2/repository
41 |           key: ${{ runner.os }}-maven-${{ hashFiles('**/pom.xml') }}
42 |           restore-keys: |
43 |             ${{ runner.os }}-maven-
44 |       - name: Set up JDK
45 |         uses: actions/setup-java@v1
46 |         with:
47 |           java-version: '11'
48 |       - name: Build Project
49 |         run: mvn -B clean verify --file pom.xml
50 |       - name: Analyze with SonarCloud
51 |         run: mvn -B sonar:sonar -Dsonar.projectKey=com.github.rchukh:trino-querylog -Dsonar.organization=rchukh-github -Dsonar.host.url=https://sonarcloud.io -Dsonar.login=$SONAR_TOKEN --file pom.xml
52 |         env:
53 |           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
54 |           SONAR_TOKEN: ${{ secrets.SONAR_TOKEN }}
55 | 


--------------------------------------------------------------------------------
/src/main/java/com/github/trino/querylog/QueryLogListener.java:
--------------------------------------------------------------------------------
 1 | /*
 2 |  * Licensed under the Apache License, Version 2.0 (the "License");
 3 |  * you may not use this file except in compliance with the License.
 4 |  * You may obtain a copy of the License at
 5 |  *
 6 |  *     http://www.apache.org/licenses/LICENSE-2.0
 7 |  *
 8 |  * Unless required by applicable law or agreed to in writing, software
 9 |  * distributed under the License is distributed on an "AS IS" BASIS,
10 |  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
11 |  * See the License for the specific language governing permissions and
12 |  * limitations under the License.
13 |  */
14 | package com.github.trino.querylog;
15 | 
16 | import io.trino.spi.eventlistener.EventListener;
17 | import io.trino.spi.eventlistener.QueryCompletedEvent;
18 | import io.trino.spi.eventlistener.QueryCreatedEvent;
19 | import io.trino.spi.eventlistener.SplitCompletedEvent;
20 | import org.apache.logging.log4j.Logger;
21 | import org.apache.logging.log4j.core.LoggerContext;
22 | import org.apache.logging.log4j.message.ObjectMessage;
23 | 
24 | public class QueryLogListener implements EventListener {
25 |     private final Logger logger;
26 |     private final boolean trackEventCreated;
27 |     private final boolean trackEventCompleted;
28 |     private final boolean trackEventCompletedSplit;
29 | 
30 |     public QueryLogListener(final LoggerContext loggerContext,
31 |                             final boolean trackEventCreated,
32 |                             final boolean trackEventCompleted,
33 |                             final boolean trackEventCompletedSplit) {
34 |         this.trackEventCreated = trackEventCreated;
35 |         this.trackEventCompleted = trackEventCompleted;
36 |         this.trackEventCompletedSplit = trackEventCompletedSplit;
37 |         this.logger = loggerContext.getLogger(QueryLogListener.class.getName());
38 |     }
39 | 
40 |     @Override
41 |     public void queryCreated(final QueryCreatedEvent queryCreatedEvent) {
42 |         if (trackEventCreated) {
43 |             logger.info(new ObjectMessage(queryCreatedEvent));
44 |         }
45 |     }
46 | 
47 |     @Override
48 |     public void queryCompleted(final QueryCompletedEvent queryCompletedEvent) {
49 |         if (trackEventCompleted) {
50 |             logger.info(new ObjectMessage(queryCompletedEvent));
51 |         }
52 |     }
53 | 
54 |     @Override
55 |     public void splitCompleted(final SplitCompletedEvent splitCompletedEvent) {
56 |         if (trackEventCompletedSplit) {
57 |             logger.info(new ObjectMessage(splitCompletedEvent));
58 |         }
59 |     }
60 | }
61 | 


--------------------------------------------------------------------------------
/src/main/java/com/github/trino/querylog/QueryLogListenerFactory.java:
--------------------------------------------------------------------------------
 1 | /*
 2 |  * Licensed under the Apache License, Version 2.0 (the "License");
 3 |  * you may not use this file except in compliance with the License.
 4 |  * You may obtain a copy of the License at
 5 |  *
 6 |  *     http://www.apache.org/licenses/LICENSE-2.0
 7 |  *
 8 |  * Unless required by applicable law or agreed to in writing, software
 9 |  * distributed under the License is distributed on an "AS IS" BASIS,
10 |  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
11 |  * See the License for the specific language governing permissions and
12 |  * limitations under the License.
13 |  */
14 | package com.github.trino.querylog;
15 | 
16 | import io.trino.spi.eventlistener.EventListener;
17 | import io.trino.spi.eventlistener.EventListenerFactory;
18 | import org.apache.logging.log4j.core.LoggerContext;
19 | import org.apache.logging.log4j.core.config.Configurator;
20 | 
21 | import java.util.Map;
22 | 
23 | import static java.util.Objects.requireNonNull;
24 | 
25 | public class QueryLogListenerFactory implements EventListenerFactory {
26 |     public static final String QUERYLOG_CONFIG_LOCATION = "trino.querylog.log4j2.configLocation";
27 |     public static final String QUERYLOG_TRACK_CREATED = "trino.querylog.log.queryCreatedEvent";
28 |     public static final String QUERYLOG_TRACK_COMPLETED = "trino.querylog.log.queryCompletedEvent";
29 |     public static final String QUERYLOG_TRACK_COMPLETED_SPLIT = "trino.querylog.log.splitCompletedEvent";
30 | 
31 |     private static final String QUERYLOG_CONFIG_LOCATION_ERROR = QUERYLOG_CONFIG_LOCATION + " is null";
32 | 
33 |     @Override
34 |     public String getName() {
35 |         return "trino-querylog";
36 |     }
37 | 
38 |     @Override
39 |     public EventListener create(Map<String, String> map) {
40 |         String log4j2ConfigLocation = requireNonNull(map.get(QUERYLOG_CONFIG_LOCATION), QUERYLOG_CONFIG_LOCATION_ERROR);
41 |         LoggerContext loggerContext = Configurator.initialize("trino-querylog", log4j2ConfigLocation);
42 |         boolean trackEventCreated = getBooleanConfig(map, QUERYLOG_TRACK_CREATED, true);
43 |         boolean trackEventCompleted = getBooleanConfig(map, QUERYLOG_TRACK_COMPLETED, true);
44 |         boolean trackEventCompletedSplit = getBooleanConfig(map, QUERYLOG_TRACK_COMPLETED_SPLIT, true);
45 |         return new QueryLogListener(loggerContext, trackEventCreated, trackEventCompleted, trackEventCompletedSplit);
46 |     }
47 | 
48 |     /**
49 |      * Get {@code boolean} parameter value, or return default.
50 |      *
51 |      * @param params       Map of parameters
52 |      * @param paramName    Parameter name
53 |      * @param paramDefault Parameter default value
54 |      * @return Parameter value or default.
55 |      */
56 |     private boolean getBooleanConfig(Map<String, String> params, String paramName, boolean paramDefault) {
57 |         String value = params.get(paramName);
58 |         if (value != null && !value.trim().isEmpty()) {
59 |             return Boolean.parseBoolean(value);
60 |         }
61 |         return paramDefault;
62 |     }
63 | }
64 | 


--------------------------------------------------------------------------------
/README.md:
--------------------------------------------------------------------------------
 1 | [![Build Status](https://github.com/rchukh/trino-querylog/workflows/Unit%20Tests/badge.svg?branch=master)](https://github.com/rchukh/trino-querylog/workflows/Unit%20Tests/badge.svg?branch=master)
 2 | [![](https://jitpack.io/v/rchukh/trino-querylog.svg)](https://jitpack.io/#rchukh/trino-querylog)
 3 | 
 4 | 
 5 | # Overview
 6 | 
 7 | Trino QueryLog is a [Trino (formerly Presto SQL)](https://trino.io/) plugin for logging query events into separate log file.
 8 | 
 9 | Its main purpose is to gather queries metadata and statistics as one event per line, so it can be easily collected by external software (e.g. Elastic FileBeat which will send data to Logstash/ElasticSearch/Kibana for storage/analysis).
10 | 
11 | 
12 | ## Build
13 | 
14 | ```
15 | mvn clean package dependency:copy-dependencies -DincludeScope=runtime
16 | ```
17 | 
18 | ## Deploy
19 | 
20 | ### Copy artifacts
21 | 
22 | Copy the following artifacts (after successful build) to the Trino plugin folder (`<path_to_trino>/plugin/trino-querylog/`)
23 | ```
24 | target/dependency/*.jar
25 | target/trino-querylog-*.jar
26 | ```
27 | 
28 | ### Prepare configuration file
29 | 
30 | Create `<path_to_trino>/etc/event-listener.properties` with the following required parameters, e.g.:
31 | 
32 | ```
33 | event-listener.name=trino-querylog
34 | trino.querylog.log4j2.configLocation=<path_to_trino>/etc/querylog-log4j2.xml
35 | ```
36 | 
37 | #### Optional Parameters
38 | 
39 | | Configuration                            | Default  | Description                |
40 | | ---------------------------------------- | -------- | -------------------------- |
41 | | `trino.querylog.log.queryCreatedEvent`   | **true** | Log Query Create event.    |
42 | | `trino.querylog.log.queryCompletedEvent` | **true** | Log Query Completed event. |
43 | | `trino.querylog.log.splitCompletedEvent` | **true** | Log Split Completed event. |
44 | 
45 | * `trino.querylog.log.queryCompletedEvent` can be used for post-hoc analysis of completed queries, as it contains all of the statistics of the query.
46 | * `trino.querylog.log.splitCompletedEvent` can be used to track query progress.
47 | * `trino.querylog.log.queryCreatedEvent` can be used to track long-running queries that are stuck without progress. 
48 | 
49 | ### Create log4j2 configuration file
50 | 
51 | Prepare configuration file for logging query events, e.g. `<path_to_trino>/etc/querylog-log4j2.xml`
52 | 
53 | ```
54 | <?xml version="1.0" encoding="UTF-8"?>
55 | <Configuration status="warn" name="TrinoQueryLog" packages="">
56 |     <Appenders>
57 |         <RollingFile name="JsonRollingFile">
58 |             <FileName>/var/log/trino/trino-querylog.log</FileName>
59 |             <FilePattern>/var/log/trino/%d{yyyy-MM-dd-hh}-%i.log</FilePattern>
60 |             <JsonLayout charset="UTF-8" includeStacktrace="false"
61 |                         compact="true" eventEol="true" objectMessageAsJsonObject="true"/>
62 |             <Policies>
63 |                 <SizeBasedTriggeringPolicy size="10 MB"/>
64 |             </Policies>
65 |             <DefaultRolloverStrategy max="10"/>
66 |         </RollingFile>
67 |     </Appenders>
68 | 
69 |     <Loggers>
70 |         <Root level="INFO">
71 |             <AppenderRef ref="JsonRollingFile"/>
72 |         </Root>
73 |     </Loggers>
74 | </Configuration>
75 | ```
76 | 
77 | Most of the configuration can be safely changed, but for easier consumption by FileBeat it is advised to leave at least JsonLayout and its parameters. 
78 | 


--------------------------------------------------------------------------------
/src/test/java/com/github/trino/querylog/QueryLogListenerTest.java:
--------------------------------------------------------------------------------
  1 | package com.github.trino.querylog;
  2 | 
  3 | import io.trino.spi.eventlistener.QueryContext;
  4 | import io.trino.spi.eventlistener.QueryCreatedEvent;
  5 | import io.trino.spi.eventlistener.QueryMetadata;
  6 | import io.trino.spi.eventlistener.SplitCompletedEvent;
  7 | import io.trino.spi.eventlistener.SplitStatistics;
  8 | import io.trino.spi.resourcegroups.QueryType;
  9 | import io.trino.spi.resourcegroups.ResourceGroupId;
 10 | import io.trino.spi.session.ResourceEstimates;
 11 | import org.apache.logging.log4j.core.LoggerContext;
 12 | import org.apache.logging.log4j.core.config.Configurator;
 13 | import org.junit.jupiter.api.Test;
 14 | 
 15 | import java.io.IOException;
 16 | import java.net.URI;
 17 | import java.nio.file.Files;
 18 | import java.nio.file.Paths;
 19 | import java.time.Duration;
 20 | import java.time.Instant;
 21 | import java.util.HashMap;
 22 | import java.util.HashSet;
 23 | import java.util.List;
 24 | import java.util.Optional;
 25 | import java.util.Set;
 26 | 
 27 | import static java.time.Duration.ofMillis;
 28 | import static org.junit.jupiter.api.Assertions.assertEquals;
 29 | 
 30 | // Those are just a few very crude tests.
 31 | // TODO: Add more cases with proper structure.
 32 | // TODO: Test actual JSON output, not just its presence.
 33 | class QueryLogListenerTest {
 34 | 
 35 |     @Test
 36 |     void queryCreatedEvents() throws IOException {
 37 |         try (LoggerContext loggerContext = Configurator.initialize(
 38 |                 "queryCreatedEvents",
 39 |                 "classpath:queryCreatedEvents.xml"
 40 |         )) {
 41 |             // Given there is a listener for query created event
 42 |             QueryLogListener listener = new QueryLogListener(
 43 |                     loggerContext,
 44 |                     true, true, true
 45 |             );
 46 | 
 47 |             // When two events are created
 48 |             listener.queryCreated(prepareQueryCreatedEvent());
 49 |             listener.queryCreated(prepareQueryCreatedEvent());
 50 | 
 51 |             // Then two events should be present in the log file
 52 |             long logEventsCount = Files.lines(Paths.get("target/queryCreatedEvents.log")).count();
 53 |             assertEquals(2, logEventsCount);
 54 |         }
 55 |     }
 56 | 
 57 | 
 58 |     @Test
 59 |     void onlyQueryCreatedEvents() throws IOException {
 60 |         try (LoggerContext loggerContext = Configurator.initialize(
 61 |                 "onlyQueryCreatedEvents",
 62 |                 "classpath:onlyQueryCreatedEvents.xml"
 63 |         )) {
 64 |             // Given there is a listener for query created event
 65 |             QueryLogListener listener = new QueryLogListener(
 66 |                     loggerContext,
 67 |                     true, false, false
 68 |             );
 69 | 
 70 |             // When one created event is created
 71 |             //  And one split completed event is created
 72 |             listener.queryCreated(prepareQueryCreatedEvent());
 73 |             listener.splitCompleted(prepareSplitCompletedEvent());
 74 | 
 75 |             // Then only created event should be present in the log file
 76 |             long logEventsCount = Files.lines(Paths.get("target/onlyQueryCreatedEvents.log")).count();
 77 |             assertEquals(1, logEventsCount);
 78 |         }
 79 |     }
 80 | 
 81 |     private QueryCreatedEvent prepareQueryCreatedEvent() {
 82 |         return new QueryCreatedEvent(
 83 |                 Instant.now(),
 84 |                 prepareQueryContext(),
 85 |                 prepareQueryMetadata()
 86 |         );
 87 |     }
 88 | 
 89 |     private SplitCompletedEvent prepareSplitCompletedEvent() {
 90 |         return new SplitCompletedEvent(
 91 |                 "queryId",
 92 |                 "stageId",
 93 |                 "taskId",
 94 |                 Optional.of("catalogName"),
 95 |                 Instant.now(),
 96 |                 Optional.of(Instant.now()),
 97 |                 Optional.of(Instant.now()),
 98 |                 getSplitStatistics(),
 99 |                 Optional.empty(),
100 |                 "payload"
101 |         );
102 |     }
103 | 
104 |     private SplitStatistics getSplitStatistics() {
105 |         return new SplitStatistics(
106 |                 ofMillis(1000),
107 |                 ofMillis(2000),
108 |                 ofMillis(3000),
109 |                 ofMillis(4000),
110 |                 1,
111 |                 2,
112 |                 Optional.of(Duration.ofMillis(100)),
113 |                 Optional.of(Duration.ofMillis(200))
114 |         );
115 |     }
116 | 
117 |     private QueryMetadata prepareQueryMetadata() {
118 |         return new QueryMetadata(
119 |                 "queryId",
120 |                 Optional.empty(),
121 |                 "query",
122 |                 Optional.of("updateType"),
123 |                 Optional.of("preparedQuery"),
124 |                 "queryState",
125 |                 List.of(),
126 |                 List.of(),
127 |                 URI.create("http://localhost"),
128 |                 Optional.empty(), Optional.empty()
129 |         );
130 |     }
131 | 
132 |     private QueryContext prepareQueryContext() {
133 |         return new QueryContext(
134 |                 "user",
135 |                 Optional.of("principal"),
136 |                 Set.of(), // groups
137 |                 Optional.empty(), // traceToken
138 |                 Optional.empty(), // remoteClientAddress
139 |                 Optional.empty(), // userAgent
140 |                 Optional.empty(), // clientInfo
141 |                 new HashSet<>(), // clientTags
142 |                 new HashSet<>(), // clientCapabilities
143 |                 Optional.of("source"),
144 |                 Optional.of("catalog"),
145 |                 Optional.of("schema"),
146 |                 Optional.of(new ResourceGroupId("name")),
147 |                 new HashMap<>(), // sessionProperties
148 |                 new ResourceEstimates(Optional.empty(), Optional.empty(), Optional.of(1000L)),
149 |                 "serverAddress", "serverVersion", "environment",
150 |                 Optional.of(QueryType.SELECT)
151 |         );
152 |     }
153 | }


--------------------------------------------------------------------------------
/pom.xml:
--------------------------------------------------------------------------------
  1 | <?xml version="1.0" encoding="UTF-8"?>
  2 | <project xmlns="http://maven.apache.org/POM/4.0.0"
  3 |          xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
  4 |          xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
  5 |     <modelVersion>4.0.0</modelVersion>
  6 | 
  7 |     <groupId>com.github.rchukh</groupId>
  8 |     <artifactId>trino-querylog</artifactId>
  9 |     <version>0.4.0-SNAPSHOT</version>
 10 |     <name>Trino Query Log</name>
 11 | 
 12 |     <properties>
 13 |         <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
 14 |         <maven.compiler.release>11</maven.compiler.release>
 15 |         <log4j2.version>2.14.0</log4j2.version>
 16 |         <trino-spi.version>351</trino-spi.version>
 17 |         <!--NOTE: Trino 351 uses Jackson 2.10.5-->
 18 |         <jackson.version>2.10.5</jackson.version>
 19 |         <!-- Test -->
 20 |         <junit.jupiter.version>5.7.1</junit.jupiter.version>
 21 |         <sonar.coverage.jacoco.xmlReportPaths>${project.build.directory}/site/jacoco/jacoco.xml</sonar.coverage.jacoco.xmlReportPaths>
 22 |     </properties>
 23 | 
 24 |     <dependencies>
 25 |         <!-- Trino Dependencies (should be presented on the server) -->
 26 |         <dependency>
 27 |             <groupId>io.trino</groupId>
 28 |             <artifactId>trino-spi</artifactId>
 29 |             <version>${trino-spi.version}</version>
 30 |             <scope>provided</scope>
 31 |         </dependency>
 32 | 
 33 |         <!-- Plugin dependency -->
 34 |         <dependency>
 35 |             <groupId>org.apache.logging.log4j</groupId>
 36 |             <artifactId>log4j-core</artifactId>
 37 |             <version>${log4j2.version}</version>
 38 |         </dependency>
 39 |         <!-- Although Jackson is used by plugin, it is better to align the version with the one used in Trino  -->
 40 |         <dependency>
 41 |             <groupId>com.fasterxml.jackson.core</groupId>
 42 |             <artifactId>jackson-databind</artifactId>
 43 |             <version>${jackson.version}</version>
 44 |         </dependency>
 45 |         <dependency>
 46 |             <groupId>com.fasterxml.jackson.core</groupId>
 47 |             <artifactId>jackson-annotations</artifactId>
 48 |             <version>${jackson.version}</version>
 49 |         </dependency>
 50 | 
 51 |         <!-- TEST -->
 52 |         <dependency>
 53 |             <groupId>org.junit.jupiter</groupId>
 54 |             <artifactId>junit-jupiter-api</artifactId>
 55 |             <version>${junit.jupiter.version}</version>
 56 |             <scope>test</scope>
 57 |         </dependency>
 58 |         <dependency>
 59 |             <groupId>org.junit.jupiter</groupId>
 60 |             <artifactId>junit-jupiter-engine</artifactId>
 61 |             <version>${junit.jupiter.version}</version>
 62 |             <scope>test</scope>
 63 |         </dependency>
 64 |     </dependencies>
 65 | 
 66 | 
 67 |     <build>
 68 |         <plugins>
 69 |             <plugin>
 70 |                 <artifactId>maven-compiler-plugin</artifactId>
 71 |                 <version>3.8.1</version>
 72 |                 <configuration>
 73 |                     <release>${maven.compiler.release}</release>
 74 |                     <encoding>${project.build.sourceEncoding}</encoding>
 75 |                 </configuration>
 76 |             </plugin>
 77 |             <plugin>
 78 |                 <groupId>org.apache.maven.plugins</groupId>
 79 |                 <artifactId>maven-dependency-plugin</artifactId>
 80 |                 <version>3.1.2</version>
 81 |             </plugin>
 82 |             <plugin>
 83 |                 <groupId>org.apache.maven.plugins</groupId>
 84 |                 <artifactId>maven-surefire-plugin</artifactId>
 85 |                 <version>2.22.2</version>
 86 |                 <dependencies>
 87 |                     <dependency>
 88 |                         <groupId>org.junit.jupiter</groupId>
 89 |                         <artifactId>junit-jupiter-engine</artifactId>
 90 |                         <version>${junit.jupiter.version}</version>
 91 |                     </dependency>
 92 |                 </dependencies>
 93 |             </plugin>
 94 |             <plugin>
 95 |                 <groupId>org.apache.maven.plugins</groupId>
 96 |                 <artifactId>maven-source-plugin</artifactId>
 97 |                 <version>3.2.1</version>
 98 |                 <executions>
 99 |                     <execution>
100 |                         <id>attach-sources</id>
101 |                         <goals>
102 |                             <goal>jar</goal>
103 |                         </goals>
104 |                     </execution>
105 |                 </executions>
106 |             </plugin>
107 |             <plugin>
108 |                 <groupId>org.apache.maven.plugins</groupId>
109 |                 <artifactId>maven-javadoc-plugin</artifactId>
110 |                 <version>3.2.0</version>
111 |                 <configuration>
112 |                     <release>${maven.compiler.release}</release>
113 |                 </configuration>
114 |                 <executions>
115 |                     <execution>
116 |                         <id>attach-javadocs</id>
117 |                         <goals>
118 |                             <goal>jar</goal>
119 |                         </goals>
120 |                     </execution>
121 |                 </executions>
122 |             </plugin>
123 |             <plugin>
124 |                 <groupId>org.apache.maven.plugins</groupId>
125 |                 <artifactId>maven-assembly-plugin</artifactId>
126 |                 <version>3.3.0</version>
127 |                 <executions>
128 |                     <execution>
129 |                         <phase>package</phase>
130 |                         <goals>
131 |                             <goal>single</goal>
132 |                         </goals>
133 |                         <configuration>
134 |                             <descriptors>
135 |                                 <descriptor>src/main/assembly/zip.xml</descriptor>
136 |                             </descriptors>
137 |                         </configuration>
138 |                     </execution>
139 |                 </executions>
140 |             </plugin>
141 |             <plugin>
142 |                 <groupId>org.jacoco</groupId>
143 |                 <artifactId>jacoco-maven-plugin</artifactId>
144 |                 <version>0.8.6</version>
145 |                 <executions>
146 |                     <execution>
147 |                         <id>prepare-agent</id>
148 |                         <goals>
149 |                             <goal>prepare-agent</goal>
150 |                         </goals>
151 |                     </execution>
152 |                     <execution>
153 |                         <id>report</id>
154 |                         <phase>verify</phase>
155 |                         <goals>
156 |                             <goal>report</goal>
157 |                         </goals>
158 |                     </execution>
159 |                 </executions>
160 |             </plugin>
161 |         </plugins>
162 |     </build>
163 | </project>
164 | 


--------------------------------------------------------------------------------
/LICENSE:
--------------------------------------------------------------------------------
  1 |                                  Apache License
  2 |                            Version 2.0, January 2004
  3 |                         http://www.apache.org/licenses/
  4 | 
  5 |    TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
  6 | 
  7 |    1. Definitions.
  8 | 
  9 |       "License" shall mean the terms and conditions for use, reproduction,
 10 |       and distribution as defined by Sections 1 through 9 of this document.
 11 | 
 12 |       "Licensor" shall mean the copyright owner or entity authorized by
 13 |       the copyright owner that is granting the License.
 14 | 
 15 |       "Legal Entity" shall mean the union of the acting entity and all
 16 |       other entities that control, are controlled by, or are under common
 17 |       control with that entity. For the purposes of this definition,
 18 |       "control" means (i) the power, direct or indirect, to cause the
 19 |       direction or management of such entity, whether by contract or
 20 |       otherwise, or (ii) ownership of fifty percent (50%) or more of the
 21 |       outstanding shares, or (iii) beneficial ownership of such entity.
 22 | 
 23 |       "You" (or "Your") shall mean an individual or Legal Entity
 24 |       exercising permissions granted by this License.
 25 | 
 26 |       "Source" form shall mean the preferred form for making modifications,
 27 |       including but not limited to software source code, documentation
 28 |       source, and configuration files.
 29 | 
 30 |       "Object" form shall mean any form resulting from mechanical
 31 |       transformation or translation of a Source form, including but
 32 |       not limited to compiled object code, generated documentation,
 33 |       and conversions to other media types.
 34 | 
 35 |       "Work" shall mean the work of authorship, whether in Source or
 36 |       Object form, made available under the License, as indicated by a
 37 |       copyright notice that is included in or attached to the work
 38 |       (an example is provided in the Appendix below).
 39 | 
 40 |       "Derivative Works" shall mean any work, whether in Source or Object
 41 |       form, that is based on (or derived from) the Work and for which the
 42 |       editorial revisions, annotations, elaborations, or other modifications
 43 |       represent, as a whole, an original work of authorship. For the purposes
 44 |       of this License, Derivative Works shall not include works that remain
 45 |       separable from, or merely link (or bind by name) to the interfaces of,
 46 |       the Work and Derivative Works thereof.
 47 | 
 48 |       "Contribution" shall mean any work of authorship, including
 49 |       the original version of the Work and any modifications or additions
 50 |       to that Work or Derivative Works thereof, that is intentionally
 51 |       submitted to Licensor for inclusion in the Work by the copyright owner
 52 |       or by an individual or Legal Entity authorized to submit on behalf of
 53 |       the copyright owner. For the purposes of this definition, "submitted"
 54 |       means any form of electronic, verbal, or written communication sent
 55 |       to the Licensor or its representatives, including but not limited to
 56 |       communication on electronic mailing lists, source code control systems,
 57 |       and issue tracking systems that are managed by, or on behalf of, the
 58 |       Licensor for the purpose of discussing and improving the Work, but
 59 |       excluding communication that is conspicuously marked or otherwise
 60 |       designated in writing by the copyright owner as "Not a Contribution."
 61 | 
 62 |       "Contributor" shall mean Licensor and any individual or Legal Entity
 63 |       on behalf of whom a Contribution has been received by Licensor and
 64 |       subsequently incorporated within the Work.
 65 | 
 66 |    2. Grant of Copyright License. Subject to the terms and conditions of
 67 |       this License, each Contributor hereby grants to You a perpetual,
 68 |       worldwide, non-exclusive, no-charge, royalty-free, irrevocable
 69 |       copyright license to reproduce, prepare Derivative Works of,
 70 |       publicly display, publicly perform, sublicense, and distribute the
 71 |       Work and such Derivative Works in Source or Object form.
 72 | 
 73 |    3. Grant of Patent License. Subject to the terms and conditions of
 74 |       this License, each Contributor hereby grants to You a perpetual,
 75 |       worldwide, non-exclusive, no-charge, royalty-free, irrevocable
 76 |       (except as stated in this section) patent license to make, have made,
 77 |       use, offer to sell, sell, import, and otherwise transfer the Work,
 78 |       where such license applies only to those patent claims licensable
 79 |       by such Contributor that are necessarily infringed by their
 80 |       Contribution(s) alone or by combination of their Contribution(s)
 81 |       with the Work to which such Contribution(s) was submitted. If You
 82 |       institute patent litigation against any entity (including a
 83 |       cross-claim or counterclaim in a lawsuit) alleging that the Work
 84 |       or a Contribution incorporated within the Work constitutes direct
 85 |       or contributory patent infringement, then any patent licenses
 86 |       granted to You under this License for that Work shall terminate
 87 |       as of the date such litigation is filed.
 88 | 
 89 |    4. Redistribution. You may reproduce and distribute copies of the
 90 |       Work or Derivative Works thereof in any medium, with or without
 91 |       modifications, and in Source or Object form, provided that You
 92 |       meet the following conditions:
 93 | 
 94 |       (a) You must give any other recipients of the Work or
 95 |           Derivative Works a copy of this License; and
 96 | 
 97 |       (b) You must cause any modified files to carry prominent notices
 98 |           stating that You changed the files; and
 99 | 
100 |       (c) You must retain, in the Source form of any Derivative Works
101 |           that You distribute, all copyright, patent, trademark, and
102 |           attribution notices from the Source form of the Work,
103 |           excluding those notices that do not pertain to any part of
104 |           the Derivative Works; and
105 | 
106 |       (d) If the Work includes a "NOTICE" text file as part of its
107 |           distribution, then any Derivative Works that You distribute must
108 |           include a readable copy of the attribution notices contained
109 |           within such NOTICE file, excluding those notices that do not
110 |           pertain to any part of the Derivative Works, in at least one
111 |           of the following places: within a NOTICE text file distributed
112 |           as part of the Derivative Works; within the Source form or
113 |           documentation, if provided along with the Derivative Works; or,
114 |           within a display generated by the Derivative Works, if and
115 |           wherever such third-party notices normally appear. The contents
116 |           of the NOTICE file are for informational purposes only and
117 |           do not modify the License. You may add Your own attribution
118 |           notices within Derivative Works that You distribute, alongside
119 |           or as an addendum to the NOTICE text from the Work, provided
120 |           that such additional attribution notices cannot be construed
121 |           as modifying the License.
122 | 
123 |       You may add Your own copyright statement to Your modifications and
124 |       may provide additional or different license terms and conditions
125 |       for use, reproduction, or distribution of Your modifications, or
126 |       for any such Derivative Works as a whole, provided Your use,
127 |       reproduction, and distribution of the Work otherwise complies with
128 |       the conditions stated in this License.
129 | 
130 |    5. Submission of Contributions. Unless You explicitly state otherwise,
131 |       any Contribution intentionally submitted for inclusion in the Work
132 |       by You to the Licensor shall be under the terms and conditions of
133 |       this License, without any additional terms or conditions.
134 |       Notwithstanding the above, nothing herein shall supersede or modify
135 |       the terms of any separate license agreement you may have executed
136 |       with Licensor regarding such Contributions.
137 | 
138 |    6. Trademarks. This License does not grant permission to use the trade
139 |       names, trademarks, service marks, or product names of the Licensor,
140 |       except as required for reasonable and customary use in describing the
141 |       origin of the Work and reproducing the content of the NOTICE file.
142 | 
143 |    7. Disclaimer of Warranty. Unless required by applicable law or
144 |       agreed to in writing, Licensor provides the Work (and each
145 |       Contributor provides its Contributions) on an "AS IS" BASIS,
146 |       WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
147 |       implied, including, without limitation, any warranties or conditions
148 |       of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
149 |       PARTICULAR PURPOSE. You are solely responsible for determining the
150 |       appropriateness of using or redistributing the Work and assume any
151 |       risks associated with Your exercise of permissions under this License.
152 | 
153 |    8. Limitation of Liability. In no event and under no legal theory,
154 |       whether in tort (including negligence), contract, or otherwise,
155 |       unless required by applicable law (such as deliberate and grossly
156 |       negligent acts) or agreed to in writing, shall any Contributor be
157 |       liable to You for damages, including any direct, indirect, special,
158 |       incidental, or consequential damages of any character arising as a
159 |       result of this License or out of the use or inability to use the
160 |       Work (including but not limited to damages for loss of goodwill,
161 |       work stoppage, computer failure or malfunction, or any and all
162 |       other commercial damages or losses), even if such Contributor
163 |       has been advised of the possibility of such damages.
164 | 
165 |    9. Accepting Warranty or Additional Liability. While redistributing
166 |       the Work or Derivative Works thereof, You may choose to offer,
167 |       and charge a fee for, acceptance of support, warranty, indemnity,
168 |       or other liability obligations and/or rights consistent with this
169 |       License. However, in accepting such obligations, You may act only
170 |       on Your own behalf and on Your sole responsibility, not on behalf
171 |       of any other Contributor, and only if You agree to indemnify,
172 |       defend, and hold each Contributor harmless for any liability
173 |       incurred by, or claims asserted against, such Contributor by reason
174 |       of your accepting any such warranty or additional liability.
175 | 
176 |    END OF TERMS AND CONDITIONS
177 | 
178 |    APPENDIX: How to apply the Apache License to your work.
179 | 
180 |       To apply the Apache License to your work, attach the following
181 |       boilerplate notice, with the fields enclosed by brackets "[]"
182 |       replaced with your own identifying information. (Don't include
183 |       the brackets!)  The text should be enclosed in the appropriate
184 |       comment syntax for the file format. We also recommend that a
185 |       file or class name and description of purpose be included on the
186 |       same "printed page" as the copyright notice for easier
187 |       identification within third-party archives.
188 | 
189 |    Copyright [yyyy] [name of copyright owner]
190 | 
191 |    Licensed under the Apache License, Version 2.0 (the "License");
192 |    you may not use this file except in compliance with the License.
193 |    You may obtain a copy of the License at
194 | 
195 |        http://www.apache.org/licenses/LICENSE-2.0
196 | 
197 |    Unless required by applicable law or agreed to in writing, software
198 |    distributed under the License is distributed on an "AS IS" BASIS,
199 |    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
200 |    See the License for the specific language governing permissions and
201 |    limitations under the License.
202 | 


--------------------------------------------------------------------------------