コンシューマグループが指定されたタイムアウト期間内にハートビートを受信しない場合、コンシューマは削除されます。 削除を防ぐには、ConsumerGroupHeartBeat APIを呼び出して、ハートビートをコンシューマーグループに送信します。
前提条件
Simple Log Serviceが有効化されています。 詳細については、「
Simple Log Serviceの有効化Python用のSimple Log Service SDKが初期化されます。 詳細については、「Simple Log Service SDK For Pythonの初期化」をご参照ください。
パラメーターの説明
def heart_beat(self, project, logstore, consumer_group, consumer, shards=None):リクエストパラメーター
パラメーター | 型 | 必須 / 任意 | 説明 |
project | String | 対象 | プロジェクトの名前。 |
logstore | String | 対象 | ログストアの名前。 |
consumer_group | String | 対象 | コンシューマーグループの名前。ログストア内で一意です。 |
消費者 | String | 任意 | コンシューマーの名前。 |
シャード | List | 非対象 | シャード0とシャード1の両方のハートビートを維持するなど、コンシューマーがハートビートを維持するシャードIDのリスト。 |
応答パラメーター
レスポンスパラメーターの詳細については、「ConsumerGroupHeartBeat」をご参照ください。
サンプルコード
from aliyun.log import LogClient
import os
# In this example, the AccessKey ID and AccessKey Secret are obtained from environment variables.
access_key_id = os.environ.get('ALIBABA_CLOUD_ACCESS_KEY_ID', '')
access_key_secret = os.environ.get('ALIBABA_CLOUD_ACCESS_KEY_SECRET', '')
# Specify a Simple Log Service endpoint.
endpoint = "cn-hangzhou.log.aliyuncs.com"
client = LogClient(endpoint, access_key_id, access_key_secret)
# Project name
project = "project-1"
# Logstore name
logstore = "logstore-1"
# consumer group name
consumer_group = "consumer_group_test"
# List of shard IDs
shards = [0, 1]
# Consumer name
consumer = ''
try:
# Create a consumer group for the specified project.
response = client.heart_beat(project, logstore, consumer_group, consumer, shards=None)
response.log_print()
except Exception as e:
print(f"An error occurred while creating the consumer group: {e}")
レスポンスの例
ListHeartBeat:
headers: {'Server': 'AliyunSLS', 'Content-Type': 'application/json', 'Content-Length': '5', 'Connection': 'keep-alive', 'Access-Control-Allow-Origin': '*', 'Date': 'Fri, 25 Oct 2024 02:46:56 GMT', 'x-log-time': '1729824416', 'x-log-requestid': '671B06A0EE24B0B90621558E'}
shards: [0, 1]関連ドキュメント
ログ消費に関連するAPIの詳細については、以下のトピックを参照してください。
詳細なサンプルコードについては、GitHubの「Alibaba Cloud Simple Log Service SDK For Python」をご参照ください。