Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

ARTEMIS-5100 support journal-max-io on 'create' CLI command #5455

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -327,6 +327,9 @@ public String[] getStaticNodes() {
@Option(names = "--jdbc-lock-expiration", description = "Lock expiration (in milliseconds).")
long jdbcLockExpiration = ActiveMQDefaultConfiguration.getDefaultJdbcLockExpirationMillis();

@Option(names = "--journal-max-aio", description = "The journal-max-io value to use when also using the ASYNCIO journal-type. When using NIO or MAPPED this value is always '1'. Default: 4096")
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Regardless what it is called, I would move this up beside the other journal related options rather than adding it after all the jdbc options (if there isnt some constraint preventing it).

The configuration impl class uses a suffix for its fields based on the journal type, JournalMaxIO_NIO and JournalMaxIO_AIO, so I'd wonder if such suffix naming convention transfers over to broker-properties usage somehow and if so might --journal-max-io-aio fit with it for alignment?

private long journalMaxAio = ActiveMQDefaultConfiguration.getDefaultJournalMaxIoAio();

private boolean isAutoCreate() {
if (autoCreate == null) {
if (noAutoCreate != null) {
Expand Down Expand Up @@ -501,6 +504,30 @@ public void setRole(String role) {
this.role = role;
}

public long getJournalMaxAio() {
return journalMaxAio;
}

public void setJournalMaxAio(long journalMaxAio) {
this.journalMaxAio = journalMaxAio;
}

public boolean isAio() {
return aio;
}

public void setAio(boolean aio) {
this.aio = aio;
}

public boolean isNio() {
return nio;
}

public void setNio(boolean nio) {
this.nio = nio;
}

private boolean isBackup() {
return slave || backup;
}
Expand Down Expand Up @@ -854,7 +881,7 @@ public Object run(ActionContext context) throws Exception {
context.out.println(String.format(" \"%s\" run", path(new File(directory, "bin/artemis"))));

File service = new File(directory, BIN_ARTEMIS_SERVICE);
context.out.println("");
context.out.println();

if (IS_NIX) {
context.out.println("Or you can run the broker in the background using:");
Expand Down Expand Up @@ -1041,7 +1068,7 @@ private void performAutoTune(HashMap<String, String> filters, JournalType journa
HashMap<String, String> syncFilter = new HashMap<>();
syncFilter.put("${nanoseconds}", "0");
syncFilter.put("${writesPerMillisecond}", "0");
syncFilter.put("${maxaio}", journalType == JournalType.ASYNCIO ? "" + ActiveMQDefaultConfiguration.getDefaultJournalMaxIoAio() : "1");
syncFilter.put("${maxaio}", "1");

getActionContext().out.println("...Since you disabled sync and are using MAPPED journal, we are diabling buffer times");

Expand All @@ -1058,7 +1085,7 @@ private void performAutoTune(HashMap<String, String> filters, JournalType journa
HashMap<String, String> syncFilter = new HashMap<>();
syncFilter.put("${nanoseconds}", Long.toString(nanoseconds));
syncFilter.put("${writesPerMillisecond}", writesPerMillisecondStr);
syncFilter.put("${maxaio}", journalType == JournalType.ASYNCIO ? "" + ActiveMQDefaultConfiguration.getDefaultJournalMaxIoAio() : "1");
syncFilter.put("${maxaio}", journalType == JournalType.ASYNCIO ? "" + journalMaxAio : "1");

getActionContext().out.println("done! Your system can make " + writesPerMillisecondStr +
" writes per millisecond, your journal-buffer-timeout will be " + nanoseconds);
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,86 @@
/*
* 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.activemq.artemis.cli.commands;

import java.io.BufferedReader;
import java.io.File;
import java.io.FileReader;
import java.io.IOException;

import org.apache.activemq.artemis.tests.extensions.TargetTempDirFactory;
import org.apache.activemq.artemis.utils.RandomUtil;
import org.apache.activemq.cli.test.TestActionContext;
import org.junit.jupiter.api.BeforeEach;
import org.junit.jupiter.api.Test;
import org.junit.jupiter.api.io.TempDir;

import static org.junit.jupiter.api.Assertions.assertFalse;
import static org.junit.jupiter.api.Assertions.assertTrue;

public class CreateTestIndividualSettings {

@TempDir(factory = TargetTempDirFactory.class)
public File temporaryFolder;

public TestActionContext context;
public File testInstance;

@BeforeEach
public void setUp() {
context = new TestActionContext();
testInstance = new File(temporaryFolder, "test-instance");
}

@Test
public void testAioJournalMaxIo() throws Exception {
long aioJournalMaxIo = RandomUtil.randomLong();

Create c = new Create();
c.setAio(true);
c.setJournalMaxAio(aioJournalMaxIo);
c.setInstance(testInstance);
c.execute(context);

assertTrue(fileContains(new File(testInstance, "etc/" + Create.ETC_BROKER_XML), "<journal-max-io>" + aioJournalMaxIo + "</journal-max-io"));
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Missing the ">" element close at end, both here and below.

}

@Test
public void testAioJournalMaxIoNegative() throws Exception {
long aioJournalMaxIo = RandomUtil.randomLong();

Create c = new Create();
c.setNio(true);
c.setJournalMaxAio(aioJournalMaxIo);
c.setInstance(testInstance);
c.execute(context);

assertFalse(fileContains(new File(testInstance, "etc/" + Create.ETC_BROKER_XML), "<journal-max-io>" + aioJournalMaxIo + "</journal-max-io"));
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is it expected to write "<journal-max-io>1</journal-max-io>" instead? If so should it perhaps assert that also?

}

private boolean fileContains(File file, String search) {
try (BufferedReader br = new BufferedReader(new FileReader(file))) {
String line;
while ((line = br.readLine()) != null) {
if (line.contains(search)) {
return true;
}
}
} catch (IOException e) {
}
return false;
}
}