diff --git a/manager/pom.xml b/manager/pom.xml
index 50b31d82fb3..dd53419f1e1 100644
--- a/manager/pom.xml
+++ b/manager/pom.xml
@@ -37,6 +37,7 @@
<easy-poi.version>4.3.0</easy-poi.version>
<huawei.sdk.version>3.1.37</huawei.sdk.version>
<huawei.obs.version>3.23.5</huawei.obs.version>
+ <alibaba.oss.version>3.17.4</alibaba.oss.version>
</properties>
<dependencies>
@@ -198,6 +199,11 @@
</exclusion>
</exclusions>
</dependency>
+ <dependency>
+ <groupId>com.aliyun.oss</groupId>
+ <artifactId>aliyun-sdk-oss</artifactId>
+ <version>${alibaba.oss.version}</version>
+ </dependency>
</dependencies>
<build>
diff --git a/manager/src/main/java/org/apache/hertzbeat/manager/pojo/dto/ObjectStoreDTO.java b/manager/src/main/java/org/apache/hertzbeat/manager/pojo/dto/ObjectStoreDTO.java
index 0a8a6fdb00b..07aca4ed2c6 100644
--- a/manager/src/main/java/org/apache/hertzbeat/manager/pojo/dto/ObjectStoreDTO.java
+++ b/manager/src/main/java/org/apache/hertzbeat/manager/pojo/dto/ObjectStoreDTO.java
@@ -54,7 +54,12 @@ public enum Type {
/**
* <a href="https://support.huaweicloud.com/obs/index.html">Huawei Cloud OBS</a>
*/
- OBS
+ OBS,
+
+ /**
+ * <a href="https://oss.console.aliyun.com/services/tools">Alibaba Cloud OSS</a>
+ */
+ OSS,
}
/**
@@ -73,4 +78,20 @@ public static class ObsConfig {
private String savePath = "hertzbeat";
}
+ /**
+ * file oss storage configuration
+ */
+ @Data
+ public static class OssConfig {
+ private String accessKey;
+ private String secretKey;
+ private String bucketName;
+ private String endpoint;
+
+ /**
+ * Save path
+ */
+ private String savePath = "hertzbeat";
+ }
+
}
diff --git a/manager/src/main/java/org/apache/hertzbeat/manager/service/impl/ObjectStoreConfigServiceImpl.java b/manager/src/main/java/org/apache/hertzbeat/manager/service/impl/ObjectStoreConfigServiceImpl.java
index ed7dbef1d59..7425f863599 100644
--- a/manager/src/main/java/org/apache/hertzbeat/manager/service/impl/ObjectStoreConfigServiceImpl.java
+++ b/manager/src/main/java/org/apache/hertzbeat/manager/service/impl/ObjectStoreConfigServiceImpl.java
@@ -17,6 +17,7 @@
package org.apache.hertzbeat.manager.service.impl;
+import com.aliyun.oss.OSSClientBuilder;
import com.fasterxml.jackson.core.type.TypeReference;
import com.fasterxml.jackson.databind.ObjectMapper;
import com.obs.services.ObsClient;
@@ -83,10 +84,28 @@ public void handler(ObjectStoreDTO<T> config) {
initObs(config);
// case other object store service
}
+ if (config.getType() == ObjectStoreDTO.Type.OSS) {
+ initOss(config);
+ }
ctx.publishEvent(new ObjectStoreConfigChangeEvent(config));
}
}
+ private void initOss(ObjectStoreDTO<T> config) {
+ var ossConfig = objectMapper.convertValue(config.getConfig(), ObjectStoreDTO.OssConfig.class);
+ Assert.hasText(ossConfig.getAccessKey(), "cannot find oss accessKey");
+ Assert.hasText(ossConfig.getSecretKey(), "cannot find oss secretKey");
+ Assert.hasText(ossConfig.getEndpoint(), "cannot find oss endpoint");
+ Assert.hasText(ossConfig.getBucketName(), "cannot find oss bucket name");
+
+ var ossClient = new OSSClientBuilder().build(ossConfig.getEndpoint(), ossConfig.getAccessKey(), ossConfig.getSecretKey());
+
+ beanFactory.destroySingleton(BEAN_NAME);
+ beanFactory.registerSingleton(BEAN_NAME, new OssObjectStoreServiceImpl(ossClient, ossConfig.getBucketName(), ossConfig.getSavePath()));
+
+ log.info("oss store service init success.");
+ }
+
/**
* init Huawei Cloud OBS
*/
diff --git a/manager/src/main/java/org/apache/hertzbeat/manager/service/impl/OssObjectStoreServiceImpl.java b/manager/src/main/java/org/apache/hertzbeat/manager/service/impl/OssObjectStoreServiceImpl.java
new file mode 100644
index 00000000000..3f6ec362178
--- /dev/null
+++ b/manager/src/main/java/org/apache/hertzbeat/manager/service/impl/OssObjectStoreServiceImpl.java
@@ -0,0 +1,90 @@
+/*
+ * 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.hertzbeat.manager.service.impl;
+
+import com.aliyun.oss.OSS;
+import com.aliyun.oss.model.ListObjectsRequest;
+import com.aliyun.oss.model.OSSObjectSummary;
+import java.io.InputStream;
+import java.util.List;
+import java.util.Objects;
+import lombok.extern.slf4j.Slf4j;
+import org.apache.hertzbeat.common.constants.SignConstants;
+import org.apache.hertzbeat.manager.pojo.dto.FileDTO;
+import org.apache.hertzbeat.manager.pojo.dto.ObjectStoreDTO;
+import org.apache.hertzbeat.manager.service.ObjectStoreService;
+
+/**
+ * Alibaba cloud storage service
+ */
+@Slf4j
+public class OssObjectStoreServiceImpl implements ObjectStoreService {
+
+ private final OSS ossClient;
+
+ private final String bucketName;
+ private final String rootPath;
+
+ public OssObjectStoreServiceImpl(OSS ossClient, String bucketName, String rootPath) {
+ this.ossClient = ossClient;
+ this.bucketName = bucketName;
+ if (rootPath.startsWith(SignConstants.RIGHT_DASH)) {
+ this.rootPath = rootPath.substring(1);
+ } else {
+ this.rootPath = rootPath;
+ }
+ }
+
+ @Override
+ public boolean upload(String filePath, InputStream is) {
+ var objectKey = getObjectKey(filePath);
+ var response = ossClient.putObject(bucketName, objectKey, is);
+ return Objects.equals(response.getResponse().getStatusCode(), 200);
+ }
+
+ @Override
+ public FileDTO download(String filePath) {
+ var objectKey = getObjectKey(filePath);
+ try {
+ var ossObject = ossClient.getObject(bucketName, objectKey);
+ return new FileDTO(filePath, ossObject.getObjectContent());
+ } catch (Exception ex) {
+ log.warn("download file from oss error {}", objectKey);
+ return null;
+ }
+ }
+
+ @Override
+ public List<FileDTO> list(String dir) {
+ var request = new ListObjectsRequest(bucketName);
+ request.setPrefix(getObjectKey(dir));
+ return ossClient.listObjects(request).getObjectSummaries().stream()
+ .map(OSSObjectSummary::getKey).toList().stream()
+ .map(k -> new FileDTO(k, ossClient.getObject(bucketName, k).getObjectContent())).toList();
+ }
+
+ @Override
+ public ObjectStoreDTO.Type type() {
+ return ObjectStoreDTO.Type.OSS;
+ }
+
+
+ private String getObjectKey(String filePath) {
+ return rootPath + SignConstants.RIGHT_DASH + filePath;
+ }
+}
diff --git a/web-app/src/app/pojo/ObjectStore.ts b/web-app/src/app/pojo/ObjectStore.ts
index d8faed5ed85..915fa9dc149 100644
--- a/web-app/src/app/pojo/ObjectStore.ts
+++ b/web-app/src/app/pojo/ObjectStore.ts
@@ -32,7 +32,11 @@ export enum ObjectStoreType {
/**
* <a href="https://support.huaweicloud.com/obs/index.html">华为云OBS</a>
*/
- OBS = 'OBS'
+ OBS = 'OBS',
+ /**
+ * <a href="https://oss.console.aliyun.com/services/tools">Alibaba Cloud OSS</a>
+ */
+ OSS = 'OSS'
}
export class ObsConfig {
@@ -42,3 +46,11 @@ export class ObsConfig {
endpoint!: string;
savePath: string = 'hertzbeat';
}
+
+export class OssConfig {
+ accessKey!: string;
+ secretKey!: string;
+ bucketName!: string;
+ endpoint!: string;
+ savePath: string = 'hertzbeat';
+}
diff --git a/web-app/src/app/routes/setting/settings/object-store/object-store.component.html b/web-app/src/app/routes/setting/settings/object-store/object-store.component.html
index 741fe310126..99a2b6f9d54 100644
--- a/web-app/src/app/routes/setting/settings/object-store/object-store.component.html
+++ b/web-app/src/app/routes/setting/settings/object-store/object-store.component.html
@@ -32,16 +32,21 @@
>
<nz-option [nzValue]="ObjectStoreType.FILE" [nzLabel]="'settings.object-store.type.file' | i18n"></nz-option>
<nz-option [nzValue]="ObjectStoreType.OBS" [nzLabel]="'settings.object-store.type.obs' | i18n"></nz-option>
+ <nz-option [nzValue]="ObjectStoreType.OSS" [nzLabel]="'settings.object-store.type.oss' | i18n"></nz-option>
</nz-select>
</nz-form-item>
- <nz-form-item *ngIf="config.type == ObjectStoreType.OBS">
+ <nz-form-item *ngIf="config.type == ObjectStoreType.OBS || config.type == ObjectStoreType.OSS">
<nz-form-label [nzSpan]="6" nzFor="obs.accessKey" nzRequired="true">{{
'settings.object-store.obs.accessKey' | i18n
}}</nz-form-label>
<nz-form-control [nzErrorTip]="'validation.required' | i18n">
<input
[(ngModel)]="config.config.accessKey"
- placeholder="{{ 'settings.object-store.obs.accessKey.placeholder' | i18n }}"
+ placeholder="{{
+ config.type == ObjectStoreType.OBS
+ ? ('settings.object-store.obs.accessKey.placeholder' | i18n)
+ : ('settings.object-store.oss.accessKey.placeholder' | i18n)
+ }}"
nz-input
required
name="accessKey"
@@ -50,14 +55,18 @@
/>
</nz-form-control>
</nz-form-item>
- <nz-form-item *ngIf="config.type == ObjectStoreType.OBS">
+ <nz-form-item *ngIf="config.type == ObjectStoreType.OBS || config.type == ObjectStoreType.OSS">
<nz-form-label [nzSpan]="6" nzFor="obs.secretKey" nzRequired="true">{{
'settings.object-store.obs.secretKey' | i18n
}}</nz-form-label>
<nz-form-control [nzErrorTip]="'validation.required' | i18n">
<input
[(ngModel)]="config.config.secretKey"
- placeholder="{{ 'settings.object-store.obs.secretKey.placeholder' | i18n }}"
+ placeholder="{{
+ config.type == ObjectStoreType.OBS
+ ? ('settings.object-store.obs.secretKey.placeholder' | i18n)
+ : ('settings.object-store.oss.secretKey.placeholder' | i18n)
+ }}"
nz-input
required
name="secretKey"
@@ -66,14 +75,18 @@
/>
</nz-form-control>
</nz-form-item>
- <nz-form-item *ngIf="config.type == ObjectStoreType.OBS">
+ <nz-form-item *ngIf="config.type == ObjectStoreType.OBS || config.type == ObjectStoreType.OSS">
<nz-form-label [nzSpan]="6" nzFor="obs.bucketName" nzRequired="true">{{
'settings.object-store.obs.bucketName' | i18n
}}</nz-form-label>
<nz-form-control [nzErrorTip]="'validation.required' | i18n">
<input
[(ngModel)]="config.config.bucketName"
- placeholder="{{ 'settings.object-store.obs.bucketName.placeholder' | i18n }}"
+ placeholder="{{
+ config.type == ObjectStoreType.OBS
+ ? ('settings.object-store.obs.bucketName.placeholder' | i18n)
+ : ('settings.object-store.oss.bucketName.placeholder' | i18n)
+ }}"
nz-input
required
name="bucketName"
@@ -82,14 +95,18 @@
/>
</nz-form-control>
</nz-form-item>
- <nz-form-item *ngIf="config.type == ObjectStoreType.OBS">
+ <nz-form-item *ngIf="config.type == ObjectStoreType.OBS || config.type == ObjectStoreType.OSS">
<nz-form-label [nzSpan]="6" nzFor="obs.endpoint" nzRequired="true">{{
'settings.object-store.obs.endpoint' | i18n
}}</nz-form-label>
<nz-form-control [nzErrorTip]="'validation.required' | i18n">
<input
[(ngModel)]="config.config.endpoint"
- placeholder="{{ 'settings.object-store.obs.endpoint.placeholder' | i18n }}"
+ placeholder="{{
+ config.type == ObjectStoreType.OBS
+ ? ('settings.object-store.obs.endpoint.placeholder' | i18n)
+ : ('settings.object-store.oss.endpoint.placeholder' | i18n)
+ }}"
nz-input
required
name="endpoint"
@@ -98,14 +115,18 @@
/>
</nz-form-control>
</nz-form-item>
- <nz-form-item *ngIf="config.type == ObjectStoreType.OBS">
+ <nz-form-item *ngIf="config.type == ObjectStoreType.OBS || config.type == ObjectStoreType.OSS">
<nz-form-label [nzSpan]="6" nzFor="obs.savePath" nzRequired="true">{{
'settings.object-store.obs.savePath' | i18n
}}</nz-form-label>
<nz-form-control [nzErrorTip]="'validation.required' | i18n">
<input
[(ngModel)]="config.config.savePath"
- placeholder="{{ 'settings.object-store.obs.savePath.placeholder' | i18n }}"
+ placeholder="{{
+ config.type == ObjectStoreType.OBS
+ ? ('settings.object-store.obs.savePath.placeholder' | i18n)
+ : ('settings.object-store.oss.savePath.placeholder' | i18n)
+ }}"
nz-input
required
name="savePath"
diff --git a/web-app/src/app/routes/setting/settings/object-store/object-store.component.ts b/web-app/src/app/routes/setting/settings/object-store/object-store.component.ts
index 1aee428ffe1..6cb02e72e92 100644
--- a/web-app/src/app/routes/setting/settings/object-store/object-store.component.ts
+++ b/web-app/src/app/routes/setting/settings/object-store/object-store.component.ts
@@ -22,7 +22,7 @@ import { ChangeDetectorRef, Component, Inject, OnInit } from '@angular/core';
import { NzNotificationService } from 'ng-zorro-antd/notification';
import { finalize } from 'rxjs/operators';
-import { ObjectStore, ObjectStoreType, ObsConfig } from '../../../../pojo/ObjectStore';
+import { ObjectStore, ObjectStoreType, ObsConfig, OssConfig } from '../../../../pojo/ObjectStore';
import { GeneralConfigService } from '../../../../service/general-config.service';
const key = 'oss';
@@ -112,6 +112,9 @@ export class ObjectStoreComponent implements OnInit {
case ObjectStoreType.OBS:
this.config.config = new ObsConfig();
break;
+ case ObjectStoreType.OSS:
+ this.config.config = new OssConfig();
+ break;
}
};
diff --git a/web-app/src/assets/i18n/en-US.json b/web-app/src/assets/i18n/en-US.json
index e744c1ef5d8..eca999969d7 100644
--- a/web-app/src/assets/i18n/en-US.json
+++ b/web-app/src/assets/i18n/en-US.json
@@ -551,6 +551,7 @@
"settings.object-store.type": "File Server Provider",
"settings.object-store.type.file": "Local file (default)",
"settings.object-store.type.obs": "HUAWEI CLOUD OBS",
+ "settings.object-store.type.oss": "ALIBABA CLOUD OSS",
"settings.object-store.obs.accessKey": "AccessKey",
"settings.object-store.obs.accessKey.placeholder": "Access Key ID of HUAWEI CLOUD",
"settings.object-store.obs.secretKey": "SecretKey",
@@ -561,6 +562,16 @@
"settings.object-store.obs.endpoint.placeholder": "HUAWEI CLOUD OBS domain name, excluding the bucket name",
"settings.object-store.obs.savePath": "SavePath",
"settings.object-store.obs.savePath.placeholder": "Path to save the backup file, The default value is hertzbeat.",
+ "settings.object-store.oss.accessKey": "AccessKey",
+ "settings.object-store.oss.accessKey.placeholder": "Access Key ID of ALIBABA CLOUD",
+ "settings.object-store.oss.secretKey": "SecretKey",
+ "settings.object-store.oss.secretKey.placeholder": "Access Key Secret of ALIBABA CLOUD",
+ "settings.object-store.oss.bucketName": "Bucket",
+ "settings.object-store.oss.bucketName.placeholder": "The name of the bucket you created in ALIBABA CLOUD OSS",
+ "settings.object-store.oss.endpoint": "EndPoint",
+ "settings.object-store.oss.endpoint.placeholder": "ALIBABA CLOUD OSS domain name, excluding the bucket name",
+ "settings.object-store.oss.savePath": "SavePath",
+ "settings.object-store.oss.savePath.placeholder": "Path to save the backup file, The default value is hertzbeat.",
"collector": "Collector",
"collector.name": "Collector Name",
"collector.name.placeholder": "Please config the unique name of the collector",
diff --git a/web-app/src/assets/i18n/zh-CN.json b/web-app/src/assets/i18n/zh-CN.json
index 4ae1609ce8c..ed39d841d50 100644
--- a/web-app/src/assets/i18n/zh-CN.json
+++ b/web-app/src/assets/i18n/zh-CN.json
@@ -552,6 +552,7 @@
"settings.object-store.type": "文件服务提供商",
"settings.object-store.type.file": "本地文件（默认）",
"settings.object-store.type.obs": "华为云OBS",
+ "settings.object-store.type.oss": "阿里云OSS",
"settings.object-store.obs.accessKey": "AccessKey",
"settings.object-store.obs.accessKey.placeholder": "华为云的AccessKeyId",
"settings.object-store.obs.secretKey": "SecretKey",
@@ -562,6 +563,16 @@
"settings.object-store.obs.endpoint.placeholder": "华为云OBS地域域名，不包括Bucket名",
"settings.object-store.obs.savePath": "保存路径",
"settings.object-store.obs.savePath.placeholder": "备份文件保存路径, 默认是hertzbeat",
+ "settings.object-store.oss.accessKey": "AccessKey",
+ "settings.object-store.oss.accessKey.placeholder": "阿里云的AccessKeyId",
+ "settings.object-store.oss.secretKey": "SecretKey",
+ "settings.object-store.oss.secretKey.placeholder": "阿里云的AccessKeySecret",
+ "settings.object-store.oss.bucketName": "Bucket",
+ "settings.object-store.oss.bucketName.placeholder": "阿里云OSS中您创建的Bucket名称",
+ "settings.object-store.oss.endpoint": "EndPoint",
+ "settings.object-store.oss.endpoint.placeholder": "阿里云OSS地域域名，不包括Bucket名",
+ "settings.object-store.oss.savePath": "保存路径",
+ "settings.object-store.oss.savePath.placeholder": "备份文件保存路径, 默认是hertzbeat",
"collector": "采集器",
"collector.name": "采集器名称",
"collector.name.placeholder": "请配置待部署的采集器名称，注意需保证唯一性",
diff --git a/web-app/src/assets/i18n/zh-TW.json b/web-app/src/assets/i18n/zh-TW.json
index 59b8a9726ce..6c9edd52016 100644
--- a/web-app/src/assets/i18n/zh-TW.json
+++ b/web-app/src/assets/i18n/zh-TW.json
@@ -549,6 +549,7 @@
"settings.object-store.type": "文件服務提供商",
"settings.object-store.type.file": "本地文件（默認）",
"settings.object-store.type.obs": "華為雲OBS",
+ "settings.object-store.type.oss": "阿裏雲OSS",
"settings.object-store.obs.accessKey": "AccessKey",
"settings.object-store.obs.accessKey.placeholder": "華為雲的AccessKeyId",
"settings.object-store.obs.secretKey": "SecretKey",
@@ -559,6 +560,16 @@
"settings.object-store.obs.endpoint.placeholder": "華為雲OBS地域域名，不包括Bucket名",
"settings.object-store.obs.savePath": "保存路徑",
"settings.object-store.obs.savePath.placeholder": "備份文件保存路徑, 默認是hertzbeat",
+ "settings.object-store.oss.accessKey": "AccessKey",
+ "settings.object-store.oss.accessKey.placeholder": "阿裏雲的AccessKeyId",
+ "settings.object-store.oss.secretKey": "SecretKey",
+ "settings.object-store.oss.secretKey.placeholder": "阿裏雲的AccessKeySecret",
+ "settings.object-store.oss.bucketName": "Bucket",
+ "settings.object-store.oss.bucketName.placeholder": "阿裏雲OSS中您創建的Bucket名稱",
+ "settings.object-store.oss.endpoint": "EndPoint",
+ "settings.object-store.oss.endpoint.placeholder": "阿裏雲OSS地域域名，不包括Bucket名",
+ "settings.object-store.oss.savePath": "保存路徑",
+ "settings.object-store.oss.savePath.placeholder": "備份文件保存路徑, 默認是hertzbeat",
"collector": "採集器",
"collector.name": "採集器名称",
"collector.name.placeholder": "請配置待部署的採集器名稱，注意需保證唯一性",