操作ダッシュボード operations-dashboard

クエリパフォーマンス

このヘルスチェックは AEM 6.4 で簡素化され、最近リファクタリングされた Oak QueryStats MBean（具体的には SlowQueries 属性）をチェックするようになりました。処理に時間のかかるクエリが統計に含まれている場合、ヘルスチェックは警告を返します。それ以外の場合は、OK ステータスを返します。

このヘルスチェックの MBean は、org.apache.sling.healthcheck:name=queriesStatus,type=HealthCheck です。

監視キューの長さ

監視キューの長さは、すべてのイベントリスナーとバックグラウンドオブザーバーを繰り返し処理し、それらの queueSize を maxQueueSize と比較します。

• queueSize 値が maxQueueSize 値を超えた場合（つまり、イベントがドロップされた場合）、重要ステータスを返します。
• queueSize 値が maxQueueSize * WARN_THRESHOLD を超えた場合は、警告を返します（デフォルト値は 0.75）。

各キューの最大長は個別の設定（Oak と AEM）から取得され、このヘルスチェックからは設定できません。このヘルスチェックの MBean は、org.apache.sling.healthcheck:name=ObservationQueueLengthHealthCheck,type=HealthCheck です。

クエリトラバーサルの制限

クエリトラバーサルの制限は、QueryEngineSettings MBean（具体的には LimitInMemory 属性と LimitReads 属性）をチェックし、次のステータスを返します。

• いずれかの制限が 以上の場合、警告ステータスを返します。 Integer.MAX_VALUE
• いずれかの制限が 10,000（Oak の推奨設定）より低い場合、警告ステータスを返します。
• QueryEngineSettings またはいずれかの制限を取得できない場合、重要ステータスを返します。

このヘルスチェックの Mbean は、org.apache.sling.healthcheck:name=queryTraversalLimitsBundle,type=HealthCheck です。

同期済みのクロック

このチェックは、ドキュメントノードストアクラスターにのみ関連しています。次のステータスを返します。

• インスタンスクロックが同期しなくなり、事前定義された低しきい値を超えた場合、警告ステータスを返します
• インスタンスクロックが同期しなくなり、事前定義された高しきい値を超えた場合、重要ステータスを返します

このヘルスチェックの Mbean は、org.apache.sling.healthcheck:name=slingDiscoveryOakSynchronizedClocks,type=HealthCheck です。

非同期インデックス

非同期インデックスのチェック：

• 1 つ以上のインデックス作成レーンが失敗した場合に、重大ステータスを返します

• すべてのインデックス作成レーンについて lastIndexedTime をチェックし、次のことを行います。

  • 2 時間以上前である場合は、重大ステータスを返します
  • 2 時間～45 分前の場合は、警告ステータスを返します
  • 45 分前以内の場合は、OK ステータスを返します

• いずれの条件も満たさない場合は、OK ステータスを返します

重要ステータスと警告ステータスの両方のしきい値を設定できます。このヘルスチェックの Mbean は、org.apache.sling.healthcheck:name=asyncIndexHealthCheck,type=HealthCheck です。

注意： このヘルスチェックは、AEM 6.4 で使用でき、AEM 6.3.0.1 に移植されています。

大きい Lucene インデックス

このチェックは、Lucene Index Statistics MBean によって公開されたデータを使用して大きいインデックスを識別し、次のステータスを返します。

• 10 億を超えるドキュメントを含むインデックスがある場合は、警告ステータス
• 15 億を超えるドキュメントを含むインデックスがある場合は、重要ステータス

しきい値は設定可能で、このヘルスチェックの MBean は org.apache.sling.healthcheck:name=largeIndexHealthCheck,type=HealthCheck です。

メモ： このヘルスチェックは AEM 6.4 で使用でき、AEM 6.3.2.0 に移植されています。

システムメンテナンス

システムメンテナンスは複合チェックで、すべてのメンテナンスタスクが設定した通りに実行されている場合は OK を返します。次の点に注意してください。

• 各メンテナンスタスクは、関連するヘルスチェックを伴います。
• タスクがメンテナンスウィンドウに追加されていない場合、そのヘルスチェックは重要ステータスを返します
• 監査ログおよびワークフローのパージのメンテナンスタスクを設定するか、メンテナンスウィンドウから削除します。未設定のままにすると、これらのタスクは最初の実行で失敗し、システムメンテナンスチェックで重要ステータスが返されます。
• AEM 6.4 では、Lucene バイナリのメンテナンスタスクのチェックもあります
• AEM 6.2 以前では、タスクが実行されないため、システムメンテナンスチェックは起動直後に警告ステータスを返します。6.3 以降では、最初のメンテナンスウィンドウに到達していない場合は OK を返します。

このヘルスチェックの MBean は、org.apache.sling.healthcheck:name=systemchecks,type=HealthCheck です。

レプリケーションキュー

このチェックは、レプリケーションエージェントに対して繰り返し行われ、そのキューを確認します。キューの上位にある項目については、エージェントによるレプリケーションの試行回数が確認されます。エージェントが numberOfRetriesAllowed パラメーターの値より多くレプリケーションを試行した場合、警告を返します。numberOfRetriesAllowed パラメーターは設定可能です。

このヘルスチェックの MBean は、org.apache.sling.healthcheck:name=replicationQueue,type=HealthCheck です。

Sling ジョブ

Sling ジョブは、JobManager でのキューに登録されたジョブ数をチェックし、maxNumQueueJobs しきい値と比較します。

• キューに maxNumQueueJobs より多くある場合、重大ステータスを返します
• 1 時間を超えて長時間実行されているアクティブなジョブがある場合は、重大ステータスを返します
• キューに登録されたジョブがあり、最後に完了したジョブの時間が 1 時間を超えている場合は、重大ステータスを返します

設定できるのは、キューに登録されたジョブのパラメーターの最大数のみで、デフォルト値は 1000 です。

このヘルスチェックの MBean は、org.apache.sling.healthcheck:name=slingJobs,type=HealthCheck です。

リクエストパフォーマンス

このチェックは、granite.request.metrics.timer Sling 指標を確認します。

• 75 パーセンタイルの値が重大ステータスのしきい値（デフォルト値は 500 ミリ秒）を超えている場合は、重大ステータスを返します
• 75 パーセンタイルの値が警告ステータスのしきい値（デフォルト値は 200 ミリ秒）を超えている場合は、警告ステータスを返します

このヘルスチェックの MBean は、 org.apache.sling.healthcheck:name=requestsStatus,type=HealthCheck です。

ログエラー

このチェックでは、ログにエラーがある場合に警告ステータスを返します。

このヘルスチェックの MBean は、org.apache.sling.healthcheck:name=logErrorHealthCheck,type=HealthCheck です。

ディスク容量

ディスク容量チェックは、FileStoreStats MBean を確認し、ノードストアのサイズおよびノードストアパーティション上の使用可能なディスク容量を取得します。

• リポジトリサイズに対する使用可能なディスク容量の割合が警告ステータスのしきい値（デフォルト値は 10）未満の場合は、警告ステータスを返します
• リポジトリサイズに対する使用可能なディスク容量の割合が重大ステータスのしきい値（デフォルト値は 2）未満の場合は、重大ステータスを返します

どちらのしきい値も設定可能です。このチェックは、セグメントストアを含むインスタンスに対してのみ機能します。

このヘルスチェックの MBean は、org.apache.sling.healthcheck:name=DiskSpaceHealthCheck,type=HealthCheck です。

スケジューラーヘルスチェック

このチェックでは、インスタンスで Quartz ジョブが 60 秒以上実行されている場合に警告ステータスを返します。許容される実行時間のしきい値は設定できます。

このヘルスチェックの MBean は、org.apache.sling.healthcheck:name=slingCommonsSchedulerHealthCheck,type=HealthCheck です。

セキュリティチェック

セキュリティチェックは、複数のセキュリティ関連チェックの結果を集約する複合チェックです。これらの個別ヘルスチェックは、セキュリティチェックリストドキュメントページで利用できるセキュリティチェックリストの様々な問題に対処します。このチェックは、インスタンス開始時のセキュリティスモークテストとして役立ちます。

このヘルスチェックの MBean は、org.apache.sling.healthcheck:name=codeCacheHealthCheck,type=HealthCheck です。

アクティブなバンドル

アクティブなバンドルは、すべてのバンドルのステータスをチェックします。

• いずれかのバンドルがアクティブでない場合（または開始しようとしているがレイジーアクティベーションの場合）、警告ステータスを返します
• 無視リストのバンドルのステータスを無視します

無視リストパラメーターは設定可能です。

このヘルスチェックの MBean は、org.apache.sling.healthcheck:name=inactiveBundles,type=HealthCheck です。

コードキャッシュのチェック

Java™ 7 に存在する CodeCache バグをトリガーできるいくつかの JVM 条件を検証するヘルスチェックです。

• コードキャッシュのフラッシュが有効な Java™ 7 でインスタンスが実行されている場合は、警告ステータスを返します
• Java™ 7 でインスタンスが実行されていて、予約済みコードキャッシュのサイズが最小しきい値（デフォルト値は 90 MB）よりも小さい場合は、警告ステータスを返します

minimum.code.cache.size しきい値は設定可能です。このバグについて詳しくは、こちらのページで Bug ID 8012547 を検索してください。

このヘルスチェックの MBean は、org.apache.sling.healthcheck:name=codeCacheHealthCheck,type=HealthCheck です。

リソース検索パスエラー

パス /apps/foundation/components/primary にリソースがあるかどうかをチェックします。

• 次の下に子ノードがある場合は、警告ステータスを返します /apps/foundation/components/primary

このヘルスチェックの MBean は、org.apache.sling.healthcheck:name=resourceSearchPathErrorHealthCheck,type=HealthCheck です。

granite.maintenance.isStoppable

ユーザーがタスクを停止できるかどうかを定義するブーリアン属性。タスクを停止可能と宣言した場合は、実行中に停止されたかどうかをチェックし、それに応じて対処する必要があります。デフォルトは false です。

true

オプション

granite.maintenance.mandatory

タスクが必須であり、定期的に実行する必要があるかどうかを定義するブール値属性。タスクが必須であるものの、現時点でアクティブなスケジュールウィンドウに存在しない場合は、ヘルスチェックによってエラーとして報告されます。デフォルトは false です。

true

オプション

granite.maintenance.name

タスクの一意の名前。タスクを参照する際に使用します。単純な名前にします。

MyMaintenanceTask

必須

granite.maintenance.title

このタスクに表示されるタイトル。

My Special Maintenance Task

必須

job.topics

メンテナンスタスクの一意のトピック。
Apache Sling のジョブ処理では、このトピックからジョブを開始してメンテナンスタスクを実行し、このトピック用にタスクが登録されるとタスクが実行されます。
トピック名は com/adobe/granite/maintenance/job/ から始める必要があります。

com/adobe/granite/maintenance/job/MyMaintenanceTask

必須

/*

* #%L

* sample-maintenance-task

* %%

* Copyright (C) 2014 Adobe

* %%

* Licensed 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

*

* https://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.

* #L%

*/

``

package com.adobe.granite.samples.maintenance.impl;

``

import java.io.File;

import java.util.Calendar;

import java.util.Collection;

import java.util.Map;

``

import org.apache.commons.io.FileUtils;

import org.apache.commons.io.filefilter.IOFileFilter;

import org.apache.commons.io.filefilter.TrueFileFilter;

import org.apache.felix.scr.annotations.Activate;

import org.apache.felix.scr.annotations.Component;

import org.apache.felix.scr.annotations.Properties;

import org.apache.felix.scr.annotations.Property;

import org.apache.felix.scr.annotations.Service;

import org.apache.sling.commons.osgi.PropertiesUtil;

import org.apache.sling.event.jobs.Job;

import org.apache.sling.event.jobs.consumer.JobConsumer;

import org.apache.sling.event.jobs.consumer.JobExecutionContext;

import org.apache.sling.event.jobs.consumer.JobExecutionResult;

import org.apache.sling.event.jobs.consumer.JobExecutor;

import org.slf4j.Logger;

import org.slf4j.LoggerFactory;

``

import com.adobe.granite.maintenance.MaintenanceConstants;

``

@Component(metatype = true,

label = "Delete Temp Files Maintenance Task",

description = "Maintatence Task which deletes files from a configurable temporary directory which have been modified in the last 24 hours.")

@Service

@Properties({

@Property(name = MaintenanceConstants.PROPERTY_TASK_NAME, value = "DeleteTempFilesTask", propertyPrivate = true),

@Property(name = MaintenanceConstants.PROPERTY_TASK_TITLE, value = "Delete Temp Files", propertyPrivate = true),

@Property(name = JobConsumer.PROPERTY_TOPICS, value = MaintenanceConstants.TASK_TOPIC_PREFIX

+ "DeleteTempFilesTask", propertyPrivate = true) })

public class DeleteTempFilesTask implements JobExecutor {

``

private static final Logger log = LoggerFactory.getLogger(DeleteTempFilesTask.class);

``

@Property(label = "Temporary Directory", description="Temporary Directory. Defaults to the java.io.tmpdir system property.")

private static final String PROP_TEMP_DIR = "temp.dir";

``

private File tempDir;

``

@Activate

private void activate(Map<string, object=""> properties) {

this.tempDir = new File(PropertiesUtil.toString(properties.get(PROP_TEMP_DIR),

System.getProperty("java.io.tmpdir")));

}

``

@Override

public JobExecutionResult process(Job job, JobExecutionContext context) {

log.info("Deleting old temp files from {}.", tempDir.getAbsolutePath());

Collection<file> files = FileUtils.listFiles(tempDir, new LastModifiedBeforeYesterdayFilter(),

TrueFileFilter.INSTANCE);

int counter = 0;

for (File file : files) {

log.debug("Deleting file {}.", file.getAbsolutePath());

counter++;

file.delete();

// TODO - capture the output of delete() and do something useful with it

}

return context.result().message(String.format("Deleted %s files.", counter)).succeeded();

}

``

/**

* IOFileFilter which filters out files which have been modified in the last 24 hours.

*

*/

private static class LastModifiedBeforeYesterdayFilter implements IOFileFilter {

``

private final long minTime;

``

private LastModifiedBeforeYesterdayFilter() {

Calendar cal = Calendar.getInstance();

cal.add(Calendar.DATE, -1);

this.minTime = cal.getTimeInMillis();

}

``

@Override

public boolean accept(File dir, String name) {

// this method is never actually called.

return false;

}

``

@Override

public boolean accept(File file) {

return file.lastModified() <= this.minTime;

}

}

``

}

<file></string,>

ヘルスチェック

• 重要ステータスのチェックのリスト
• 警告ステータスのチェックのリスト

色の意味：

• 赤色のタグは重要なチェック
• オレンジ色のタグは警告のチェック

• ヘルスレポートページ

メンテナンスタスク

• 失敗したタスクのリスト
• 現在実行中のタスクのリスト
• 前回の実行で成功したタスクのリスト
• 実行しなかったタスクのリスト
• スケジュールが未設定のタスクのリスト

色の意味：

• 赤色のタグは失敗したタスク
• オレンジ色のタグは実行中のタスク（これらはパフォーマンスに影響する可能性があります）
• 灰色のタグはその他のすべてのステータス

• メンテナンスタスクページ

システム

• オペレーティングシステムおよび OS バージョン（Mac OS X など）
• システム負荷平均（OperatingSystemMXBeanusable から取得されます）
• ディスク領域（ホームディレクトリがあるパーティション）
• 最大ヒープ（MemoryMXBean によって返されます）

該当なし

該当なし

インスタンス

• AEM のバージョン
• 実行モードのリスト
• インスタンスが開始された日付

該当なし

該当なし

リポジトリ

• Oak のバージョン

• ノードストアのタイプ（セグメント Tar またはドキュメント）

  • タイプがドキュメントの場合は、ドキュメントストアのタイプが表示されます（RDB または Mongo）。

• カスタムデータストアがある場合：

  • ファイルデータストアの場合は、パスが表示されます。
  • S3 データストアの場合は、S3 バケットの名前が表示されます。
  • 共有 S3 データストアの場合は、S3 バケットの名前が表示されます。
  • Azure データストアの場合は、コンテナが表示されます。

• カスタムの外部データストアがない場合は、このことを示すメッセージが表示されます。

該当なし

該当なし

配布エージェント

• キューがブロックされているエージェントのリスト
• 設定が正しくないエージェントのリスト（「設定エラー」）
• キューの処理が一時停止されているエージェントのリスト
• 待機中エージェントのリスト
• 実行中のエージェント（現在エントリを処理中）のリスト

色の意味：

• 赤色のタグはブロックされているエージェントまたは設定エラー
• オレンジ色のタグは一時停止中のエージェント
• 灰色のタグは一時停止中、待機中または実行中のエージェント

配布版ページ

レプリケーションエージェント

• キューがブロックされているエージェントのリスト
• 待機中エージェントのリスト
• 実行中のエージェント（現在エントリを処理中）のリスト

色の意味：

• 赤色のタグはブロックされているエージェント
• 灰色のタグは一時停止中のエージェント

レプリケーションページ

ワークフロー

• ワークフロージョブ：

  • 失敗したワークフロージョブの数（ある場合）
  • キャンセルされたワークフロージョブの数（ある場合）

• ワークフロー数 - 特定のステータスのワークフローの数（ある場合）：

  • 実行中
  • 失敗
  • 保留中
  • 中止

前述のステータスごとにクエリが実行されます（400 ミリ秒以内）。400 ミリ秒の時点で、その時点までに取得されたエントリ数が表示されます。

判断なし：

• 予期しないステータスのワークフローとジョブがある場合は、調査する必要があります。

ワークフローエラーページ

Sling ジョブ

Sling ジョブ数 - 特定のステータスのジョブの数（ある場合）：

• 失敗
• 待機中
• キャンセル済み
• アクティブ

判断なし：

• 予期しないステータスまたは数が大きいジョブがある場合は、調査する必要があります。

該当なし

予測ノード数

予測数：

• ページ
• アセット
• タグ
• 許可可能
• ノードの合計数

ノードの合計数は nodeCounterMBean から取得しますが、残りの統計は IndexInfoService から取得します。

該当なし

該当なし

バックアップ

この場合は、「オンラインバックアップを処理中」と表示されます。

該当なし

該当なし

インデックス作成

表示：

• 「インデックスを処理中」
• 「クエリを処理中」

インデックスまたはクエリスレッドがスレッドダンプに存在する場合。

該当なし

該当なし