Step 1: Select Target

Choose the target, including tier, server, and instance, for which you intend to take the Heap Dump.

Step 2: Heap Dump Configuration

• Count: This defines the number of heap dumps to capture. For example, setting the count to 1 will capture a single heap dump, while increasing the count will capture multiple heap dumps.
• Time Interval: This is the interval between consecutive heap dump captures. It allows you to specify the wait time in seconds. For instance, if the interval is set to 5 seconds, there will be a 5-second gap between each heap dump when the count is greater than 1.
• Heap Dump Capture Timeout: This specifies the maximum amount of time (in seconds) allowed for capturing the heap dumps. If the process takes longer than this duration, the operation will be aborted to prevent resource overuse or blocking.
  • Tooltip for Info Icon: Time after which heap dump capture will be cancelled if no response is received.

Step 3: Schedule Setting

Specifies the frequency with which the scheduler rule will be applied. You can apply either a one-time or a recurring schedule for taking heap dumps:

• One-Time: As the name suggests, a one-time schedule will apply the scheduler rule for one time ONLY. The following parameters are required to configure a one-time scheduler.
• Recurring: Recurring downtimes are useful for recurring maintenance windows. Set a recurring downtime by entering the start date, time, time zone, repeat, and duration. When a single downtime of a recurring downtime ends, the single downtime is canceled and a new downtime is created with the same constraints and updated start and end times.In this option, you have to select the Time Interval for which you want to repeat the scheduler.recurring, it contains the following parameters which are listed below:
  1. Start From: This field defines the start date of the Schedule. You can enter the date either manually or by using the calendar option.
  2. At: In this field, you need to enter the start time which is the 24-hour time format.
  3. Time Zone: This field defines the time zone for the schedule. In this field, you have to select the time zone according to your requirements from the drop-down provided. By default, the time zone will be the same as the system time zone.
  4. Repeat Every: This will define the repetitions for the scheduler. In this field, you have to select the number of occurrences ( In Seconds, Minute(s) , Hour(s) , Day(s), Weeks(s), Month(s), and Year(s) . The following recurrence options are supported:
     1. Seconds(s): Select this option to set the recurrence interval in seconds. For example, setting "10 Seconds" will repeat the task every 10 seconds.
     2. Minute(s): This option allows the recurrence to be set in minutes. For example, choosing "15 Minutes" will repeat the task every 15 minutes.
     3. Hour(s): Use This option to configure the recurrence in hours. For instance, "1 Hour" will repeat the task every hour.
     4. Day(s): Allows you to define the recurrence interval in days. For example, "1 Day" means the task will recur daily, whereas "2 Days" will repeat the task every two days.
     5. Weekly: If you select the weekly option, you can schedule heap dump capture on a weekly basis and also select the days of the week when this schedule will be activated. For example: if you select Sat & Sun in the Days of the Week section, then the heap dump capture will be executed every Saturday and Sunday from the start date and at the time mentioned in the “At” field.
     6. Monthly: In case you want to schedule heap dump capture on a monthly basis, then select the Month(s) option. Once selected, you will be able to select either the “Date” of the month on which you want to capture the heap dump or the “Weekday”. In case you select a date, you will get the option to schedule it on the date specified under Start From field. In case you select Weekday, you will have to select 1st/2nd/3rd/4th or the Last week of the month and mention the days of the week when you want to capture the heap dump. 
     7. Yearly: In case you want to capture heap dump on an yearly basis, select the Year(s) option. Once selected, you will be able to select either the “Date” of the month on which you want to capture the heap dump or the “Weekday”. In case you select a date, you will get the option to schedule it on the date specified under Start From field. In case you select Weekday, you will have to select 1st/2nd/3rd/4th or the Last week of the month and mention the days of the week when you want to capture the heap dump.
  5. End Date Section: This field defines the end date of the scheduler. In this field, you have to select the end date for the scheduler by choosing the end date from the calendar. By default, the “No End Date” will be selected in the Until parameter.
     • Note End Date: By default, this is selected. If you choose this option, the event or task will keep recurring indefinitely, with no specified end date.
     • Date: With the Date option, you can specify both the exact *end date and the time when the schedule will stop. You select a date from the calendar, and you can also set the specific time on that date when the schedule will end. This allows you to control the exact moment the scheduler should stop, ensuring the event or task finishes at a precise point in time.
     • After: It will show the number of occurrences.
       • Occurrences: Defines a specific number of repetitions before the event stops.

Note: To configure advanced settings, navigate to Configuration > Diagnostics Tools Advanced Settings.