Copilot commented on code in PR #9432: URL: https://github.com/apache/seatunnel/pull/9432#discussion_r2144048680
########## seatunnel-connectors-v2/connector-sensorsdata/src/main/java/org/apache/seatunnel/connectors/seatunnel/sensorsdata/sdk/sink/SensorsDataSDKWriter.java: ########## @@ -0,0 +1,200 @@ +/* + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed with + * this work for additional information regarding copyright ownership. + * The ASF licenses this file to You under the Apache License, Version 2.0 + * (the "License"); you may not use this file except in compliance with + * the License. You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ + +package org.apache.seatunnel.connectors.seatunnel.sensorsdata.sdk.sink; + +import org.apache.seatunnel.api.sink.SinkWriter; +import org.apache.seatunnel.api.sink.SupportMultiTableSinkWriter; +import org.apache.seatunnel.api.table.type.SeaTunnelDataType; +import org.apache.seatunnel.api.table.type.SeaTunnelRow; +import org.apache.seatunnel.api.table.type.SeaTunnelRowType; +import org.apache.seatunnel.common.utils.JsonUtils; +import org.apache.seatunnel.connectors.seatunnel.sensorsdata.sdk.config.SensorsDataSDKSinkConfig; +import org.apache.seatunnel.connectors.seatunnel.sensorsdata.sdk.exception.SensorsDataConnectorErrorCode; +import org.apache.seatunnel.connectors.seatunnel.sensorsdata.sdk.exception.SensorsDataConnectorException; +import org.apache.seatunnel.connectors.seatunnel.sensorsdata.sdk.state.SensorsDataCommitInfo; +import org.apache.seatunnel.connectors.seatunnel.sensorsdata.sdk.state.SensorsDataSinkState; +import org.apache.seatunnel.format.sensorsdata.config.TargetColumnConfig; +import org.apache.seatunnel.format.sensorsdata.record.RowAccessor; +import org.apache.seatunnel.format.sensorsdata.record.SensorsDataRecordBuilder; +import org.apache.seatunnel.format.sensorsdata.record.SpecialItemRecord; +import org.apache.seatunnel.format.sensorsdata.record.UserDetailRecord; +import org.apache.seatunnel.format.sensorsdata.record.UserEventRecord; +import org.apache.seatunnel.format.sensorsdata.record.UserRecord; +import org.apache.seatunnel.format.sensorsdata.utils.UserSchemaUtil; + +import org.apache.commons.lang3.StringUtils; + +import com.sensorsdata.analytics.javasdk.SensorsAnalytics; +import com.sensorsdata.analytics.javasdk.bean.schema.UserSchema; +import com.sensorsdata.analytics.javasdk.consumer.BatchConsumer; +import com.sensorsdata.analytics.javasdk.consumer.ConsoleConsumer; +import lombok.NonNull; +import lombok.extern.slf4j.Slf4j; + +import java.io.IOException; +import java.io.PrintWriter; +import java.lang.reflect.Array; +import java.util.ArrayList; +import java.util.List; +import java.util.Optional; +import java.util.Set; +import java.util.stream.Collectors; + +@Slf4j +public class SensorsDataSDKWriter + implements SinkWriter<SeaTunnelRow, SensorsDataCommitInfo, SensorsDataSinkState>, + SupportMultiTableSinkWriter<Void> { + + private final SensorsAnalytics sa; + private final RowAccessor rowAccessor; + private final SeaTunnelRowType seaTunnelRowType; + private final boolean isSkipErrorRecord; + private final boolean nullAsProfileUnset; + private final Set<String> allProperties; + + /** for convenient testing */ + private static final String CONSUMER_TYPE_CONSOLE = "console"; + + private final SensorsDataRecordBuilder.Builder recordBuilder; + + public SensorsDataSDKWriter( + @NonNull SeaTunnelRowType seaTunnelRowType, + @NonNull SensorsDataSDKSinkConfig sinkConfig) { + if (CONSUMER_TYPE_CONSOLE.equalsIgnoreCase(sinkConfig.getConsumer())) { + sa = new SensorsAnalytics(new ConsoleConsumer(new PrintWriter(System.out))); + } else { + sa = + new SensorsAnalytics( + new BatchConsumer( + sinkConfig.getServerUrl(), + sinkConfig.getBulkSize(), + sinkConfig.getMaxCacheRowSize(), + false, + 3, + sinkConfig.getInstantEvents())); + } + sa.setEnableTimeFree(sinkConfig.isTimeFree()); + rowAccessor = new RowAccessor(sinkConfig, seaTunnelRowType); + this.seaTunnelRowType = seaTunnelRowType; + isSkipErrorRecord = sinkConfig.isSkipErrorRecord(); + nullAsProfileUnset = sinkConfig.isNullAsProfileUnset(); + recordBuilder = SensorsDataRecordBuilder.newBuilder(sinkConfig, rowAccessor); + this.allProperties = + sinkConfig.getPropertyFields().stream() + .map(TargetColumnConfig::getTarget) + .collect(Collectors.toSet()); + } + + @Override + public void write(SeaTunnelRow row) throws IOException { + try { + switch (recordBuilder.getRecordType()) { + case USER: + UserSchema userSchema = ((UserRecord) recordBuilder.build(row)).getUserSchema(); + sa.profileSet(userSchema); + if (nullAsProfileUnset) { + UserSchema unsetUserSchema = + UserSchemaUtil.buildUnsetUserSchema(userSchema, allProperties); + if (unsetUserSchema != null) { + // do not send profile_unset if all fields are not null + sa.profileUnset(unsetUserSchema); + } + } + break; + case USER_EVENT: + sa.track(((UserEventRecord) recordBuilder.build(row)).getUserEventSchema()); + break; + case USER_DETAIL: + sa.detailSet( + ((UserDetailRecord) recordBuilder.build(row)).getUserDetailSchema()); + break; + case SPECIAL_ITEM: + sa.itemSet(((SpecialItemRecord) recordBuilder.build(row)).getItemRecord()); + break; + default: + throw new SensorsDataConnectorException( + SensorsDataConnectorErrorCode.SEND_RECORD_FAILED, Review Comment: In the default case you throw a SEND_RECORD_FAILED error code for an unsupported record type; use SensorsDataConnectorErrorCode.UNSUPPORTED_RECORD_TYPE instead. ```suggestion SensorsDataConnectorErrorCode.UNSUPPORTED_RECORD_TYPE, ``` ########## seatunnel-connectors-v2/connector-sensorsdata/src/main/java/org/apache/seatunnel/connectors/seatunnel/sensorsdata/sdk/sink/SensorsDataSDKWriter.java: ########## @@ -0,0 +1,200 @@ +/* + * Licensed to the Apache Software Foundation (ASF) under one or more + * contributor license agreements. See the NOTICE file distributed with + * this work for additional information regarding copyright ownership. + * The ASF licenses this file to You under the Apache License, Version 2.0 + * (the "License"); you may not use this file except in compliance with + * the License. You may obtain a copy of the License at + * + * http://www.apache.org/licenses/LICENSE-2.0 + * + * Unless required by applicable law or agreed to in writing, software + * distributed under the License is distributed on an "AS IS" BASIS, + * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. + * See the License for the specific language governing permissions and + * limitations under the License. + */ + +package org.apache.seatunnel.connectors.seatunnel.sensorsdata.sdk.sink; + +import org.apache.seatunnel.api.sink.SinkWriter; +import org.apache.seatunnel.api.sink.SupportMultiTableSinkWriter; +import org.apache.seatunnel.api.table.type.SeaTunnelDataType; +import org.apache.seatunnel.api.table.type.SeaTunnelRow; +import org.apache.seatunnel.api.table.type.SeaTunnelRowType; +import org.apache.seatunnel.common.utils.JsonUtils; +import org.apache.seatunnel.connectors.seatunnel.sensorsdata.sdk.config.SensorsDataSDKSinkConfig; +import org.apache.seatunnel.connectors.seatunnel.sensorsdata.sdk.exception.SensorsDataConnectorErrorCode; +import org.apache.seatunnel.connectors.seatunnel.sensorsdata.sdk.exception.SensorsDataConnectorException; +import org.apache.seatunnel.connectors.seatunnel.sensorsdata.sdk.state.SensorsDataCommitInfo; +import org.apache.seatunnel.connectors.seatunnel.sensorsdata.sdk.state.SensorsDataSinkState; +import org.apache.seatunnel.format.sensorsdata.config.TargetColumnConfig; +import org.apache.seatunnel.format.sensorsdata.record.RowAccessor; +import org.apache.seatunnel.format.sensorsdata.record.SensorsDataRecordBuilder; +import org.apache.seatunnel.format.sensorsdata.record.SpecialItemRecord; +import org.apache.seatunnel.format.sensorsdata.record.UserDetailRecord; +import org.apache.seatunnel.format.sensorsdata.record.UserEventRecord; +import org.apache.seatunnel.format.sensorsdata.record.UserRecord; +import org.apache.seatunnel.format.sensorsdata.utils.UserSchemaUtil; + +import org.apache.commons.lang3.StringUtils; + +import com.sensorsdata.analytics.javasdk.SensorsAnalytics; +import com.sensorsdata.analytics.javasdk.bean.schema.UserSchema; +import com.sensorsdata.analytics.javasdk.consumer.BatchConsumer; +import com.sensorsdata.analytics.javasdk.consumer.ConsoleConsumer; +import lombok.NonNull; +import lombok.extern.slf4j.Slf4j; + +import java.io.IOException; +import java.io.PrintWriter; +import java.lang.reflect.Array; +import java.util.ArrayList; +import java.util.List; +import java.util.Optional; +import java.util.Set; +import java.util.stream.Collectors; + +@Slf4j +public class SensorsDataSDKWriter + implements SinkWriter<SeaTunnelRow, SensorsDataCommitInfo, SensorsDataSinkState>, + SupportMultiTableSinkWriter<Void> { + + private final SensorsAnalytics sa; + private final RowAccessor rowAccessor; + private final SeaTunnelRowType seaTunnelRowType; + private final boolean isSkipErrorRecord; + private final boolean nullAsProfileUnset; + private final Set<String> allProperties; + + /** for convenient testing */ + private static final String CONSUMER_TYPE_CONSOLE = "console"; + + private final SensorsDataRecordBuilder.Builder recordBuilder; + + public SensorsDataSDKWriter( + @NonNull SeaTunnelRowType seaTunnelRowType, + @NonNull SensorsDataSDKSinkConfig sinkConfig) { + if (CONSUMER_TYPE_CONSOLE.equalsIgnoreCase(sinkConfig.getConsumer())) { + sa = new SensorsAnalytics(new ConsoleConsumer(new PrintWriter(System.out))); + } else { + sa = + new SensorsAnalytics( + new BatchConsumer( + sinkConfig.getServerUrl(), + sinkConfig.getBulkSize(), + sinkConfig.getMaxCacheRowSize(), + false, + 3, + sinkConfig.getInstantEvents())); + } + sa.setEnableTimeFree(sinkConfig.isTimeFree()); + rowAccessor = new RowAccessor(sinkConfig, seaTunnelRowType); + this.seaTunnelRowType = seaTunnelRowType; + isSkipErrorRecord = sinkConfig.isSkipErrorRecord(); + nullAsProfileUnset = sinkConfig.isNullAsProfileUnset(); + recordBuilder = SensorsDataRecordBuilder.newBuilder(sinkConfig, rowAccessor); + this.allProperties = + sinkConfig.getPropertyFields().stream() + .map(TargetColumnConfig::getTarget) + .collect(Collectors.toSet()); + } + + @Override + public void write(SeaTunnelRow row) throws IOException { + try { + switch (recordBuilder.getRecordType()) { + case USER: + UserSchema userSchema = ((UserRecord) recordBuilder.build(row)).getUserSchema(); + sa.profileSet(userSchema); + if (nullAsProfileUnset) { + UserSchema unsetUserSchema = + UserSchemaUtil.buildUnsetUserSchema(userSchema, allProperties); + if (unsetUserSchema != null) { + // do not send profile_unset if all fields are not null + sa.profileUnset(unsetUserSchema); + } + } + break; + case USER_EVENT: + sa.track(((UserEventRecord) recordBuilder.build(row)).getUserEventSchema()); + break; + case USER_DETAIL: + sa.detailSet( + ((UserDetailRecord) recordBuilder.build(row)).getUserDetailSchema()); + break; + case SPECIAL_ITEM: + sa.itemSet(((SpecialItemRecord) recordBuilder.build(row)).getItemRecord()); + break; + default: + throw new SensorsDataConnectorException( + SensorsDataConnectorErrorCode.SEND_RECORD_FAILED, + "Unsupported record type"); + } + } catch (Exception e) { + log.error("Write error", e); + log.error( + "Write error, SeaTunnelRow#tableId={} SeaTunnelRow#kind={} : [{}]", + row.getTableId(), + row.getRowKind(), + fieldsToString(row)); + if (!isSkipErrorRecord) { + throw new SensorsDataConnectorException( + SensorsDataConnectorErrorCode.SEND_RECORD_FAILED, e.getMessage()); Review Comment: When rethrowing the exception here, include the original exception as the cause (e.g., use the constructor that accepts a Throwable) to preserve the stack trace. ```suggestion SensorsDataConnectorErrorCode.SEND_RECORD_FAILED, e.getMessage(), e); ``` ########## docs/en/connector-v2/sink/SensorsData.md: ########## @@ -0,0 +1,178 @@ +import ChangeLog from '../changelog/connector-sensorsdata.md'; + +# SensorsData + +> SensorsData sink connector + +## Support Those Engines + +> Spark<br/> +> Flink<br/> +> SeaTunnel Zeta<br/> + +## Key features + +- [ ] [exactly-once](../../concept/connector-v2-features.md) + +## Description + +A sink plugin which use SensorsData SDK send data records. + +## Options + +| name | type | required | default value | +|---------------------------|---------|----------|---------------| +| server_url | string | yes | - | +| bulk_size | int | no | 50 | +| max_cache_row_size | int | no | 0 | +| consumer | string | no | - | +| entity_name | string | yes | users | +| record_type | string | yes | users | +| schema | string | yes | users | +| distinct_id_column | string | yes | - | +| identity_fields | array | yes | - | +| property_fields | array | yes | - | +| event_name | string | yes | - | +| time_column | string | yes | - | +| time_free | boolean | no | false | +| detail_id_column | string | no | - | +| item_id_column | string | no | - | +| item_type_column | string | no | - | +| skip_error_record | boolean | no | false | +| instant_events | array | no | - | +| distinct_id_by_identities | boolean | no | false | +| null_as_profile_unset | boolean | no | false | +| common-options | | no | - | + +### server_url [string] + +SensorsData data sink address, the format is https://${host}:8106/sa?project=${project} + +### bulk_size [int] + +Threshold for the triggering flush operation in SensorsData SDK. When the memory cache queue reaches this value, the +data in the cache will be sended. The default value is 50. Review Comment: Correct the verb tense here: use 'sent' instead of 'sended'. ```suggestion data in the cache will be sent. The default value is 50. ``` -- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. To unsubscribe, e-mail: [email protected] For queries about this service, please contact Infrastructure at: [email protected]
