-
Notifications
You must be signed in to change notification settings - Fork 117
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Motivation:
Central Dogma does not provide a way to dump threads or heap data.
Modifications:
- Add `ManagementConfig` to config a management service using
`dogma.json` and `CentralDogmaBuilder`
- Register `ManagementService` based on the options specified in
`ManagementService`
Example:
- Serve a management service at the same ports of the main server
```
{
"management": {
"port": 0
}
}
```
- Serve a management service only at an internal port which won't be
exposed externally.
```
{
"management": {
"address": "127.0.0.1"
"port": 36463
}
}
```
Result:
You can now configure a managemet service to dump the thread information
or heap data.- Loading branch information
Showing
7 changed files
with
349 additions
and
17 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
134 changes: 134 additions & 0 deletions
134
server/src/main/java/com/linecorp/centraldogma/server/ManagementConfig.java
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,134 @@ | ||
| /* | ||
| * Copyright 2024 LINE Corporation | ||
| * | ||
| * LINE Corporation 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: | ||
| * | ||
| * 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. | ||
| */ | ||
|
|
||
| package com.linecorp.centraldogma.server; | ||
|
|
||
| import static com.google.common.base.MoreObjects.firstNonNull; | ||
| import static com.google.common.base.Preconditions.checkArgument; | ||
|
|
||
| import java.util.Objects; | ||
|
|
||
| import com.fasterxml.jackson.annotation.JsonCreator; | ||
| import com.fasterxml.jackson.annotation.JsonProperty; | ||
| import com.google.common.base.MoreObjects; | ||
|
|
||
| import com.linecorp.armeria.common.SessionProtocol; | ||
| import com.linecorp.armeria.common.annotation.Nullable; | ||
| import com.linecorp.armeria.server.management.ManagementService; | ||
|
|
||
| /** | ||
| * A configuration for the {@link ManagementService}. | ||
| */ | ||
| public final class ManagementConfig { | ||
| private static final String DEFAULT_PROTOCOL = "http"; | ||
| private static final String DEFAULT_PATH = "/internal/management"; | ||
|
|
||
| private final SessionProtocol protocol; | ||
| private final @Nullable String address; | ||
| private final int port; | ||
| private final String path; | ||
|
|
||
| /** | ||
| * Creates a new instance. | ||
| */ | ||
| @JsonCreator | ||
| public ManagementConfig(@JsonProperty("protocol") @Nullable String protocol, | ||
| @JsonProperty("address") @Nullable String address, | ||
| @JsonProperty("port") int port, | ||
| @JsonProperty("path") @Nullable String path) { | ||
| this(SessionProtocol.of(firstNonNull(protocol, DEFAULT_PROTOCOL)), | ||
| address, port, path); | ||
| } | ||
|
|
||
| /** | ||
| * Creates a new instance. | ||
| */ | ||
| public ManagementConfig(@Nullable SessionProtocol protocol, | ||
| @Nullable String address, | ||
| int port, | ||
| @Nullable String path) { | ||
| protocol = firstNonNull(protocol, SessionProtocol.HTTP); | ||
| checkArgument(protocol != SessionProtocol.PROXY, "protocol: %s (expected: one of %s)", | ||
| protocol, SessionProtocol.httpAndHttpsValues()); | ||
| this.protocol = protocol; | ||
| this.address = address; | ||
| checkArgument(port >= 0 && port <= 65535, "%s: %s (expected: 0-65535)", "management.port", port); | ||
| this.port = port; | ||
| this.path = firstNonNull(path, DEFAULT_PATH); | ||
| } | ||
|
|
||
| /** | ||
| * Returns the protocol of the management service. | ||
| */ | ||
| @JsonProperty("protocol") | ||
| public SessionProtocol protocol() { | ||
| return protocol; | ||
| } | ||
|
|
||
| /** | ||
| * Returns the address of the management service. | ||
| */ | ||
| @JsonProperty("address") | ||
| public @Nullable String address() { | ||
| return address; | ||
| } | ||
|
|
||
| /** | ||
| * Returns the port of the management service. | ||
| */ | ||
| @JsonProperty("port") | ||
| public int port() { | ||
| return port; | ||
| } | ||
|
|
||
| /** | ||
| * Returns the path of the management service. | ||
| */ | ||
| @JsonProperty("path") | ||
| public String path() { | ||
| return path; | ||
| } | ||
|
|
||
| @Override | ||
| public boolean equals(Object o) { | ||
| if (this == o) { | ||
| return true; | ||
| } | ||
| if (!(o instanceof ManagementConfig)) { | ||
| return false; | ||
| } | ||
| final ManagementConfig that = (ManagementConfig) o; | ||
| return port == that.port && | ||
| protocol == that.protocol && | ||
| Objects.equals(address, that.address) && | ||
| path.equals(that.path); | ||
| } | ||
|
|
||
| @Override | ||
| public int hashCode() { | ||
| return Objects.hash(protocol, address, port, path); | ||
| } | ||
|
|
||
| @Override | ||
| public String toString() { | ||
| return MoreObjects.toStringHelper(this) | ||
| .add("protocol", protocol) | ||
| .add("address", address) | ||
| .add("port", port) | ||
| .add("path", path) | ||
| .toString(); | ||
| } | ||
| } |
103 changes: 103 additions & 0 deletions
103
server/src/test/java/com/linecorp/centraldogma/server/ManagementServiceTest.java
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,103 @@ | ||
| /* | ||
| * Copyright 2024 LINE Corporation | ||
| * | ||
| * LINE Corporation 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: | ||
| * | ||
| * 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. | ||
| */ | ||
|
|
||
| package com.linecorp.centraldogma.server; | ||
|
|
||
| import static org.assertj.core.api.Assertions.assertThat; | ||
|
|
||
| import org.junit.jupiter.api.Test; | ||
| import org.junit.jupiter.api.extension.RegisterExtension; | ||
|
|
||
| import com.fasterxml.jackson.core.JsonProcessingException; | ||
|
|
||
| import com.linecorp.armeria.client.BlockingWebClient; | ||
| import com.linecorp.armeria.client.ClientFactory; | ||
| import com.linecorp.armeria.client.WebClient; | ||
| import com.linecorp.armeria.common.AggregatedHttpResponse; | ||
| import com.linecorp.armeria.common.HttpStatus; | ||
| import com.linecorp.armeria.common.SessionProtocol; | ||
| import com.linecorp.armeria.internal.common.util.PortUtil; | ||
| import com.linecorp.centraldogma.internal.Jackson; | ||
| import com.linecorp.centraldogma.testing.junit.CentralDogmaExtension; | ||
|
|
||
| class ManagementServiceTest { | ||
|
|
||
| private static int tlsPort; | ||
|
|
||
| @RegisterExtension | ||
| static final CentralDogmaExtension noManagement = new CentralDogmaExtension(); | ||
|
|
||
| @RegisterExtension | ||
| static final CentralDogmaExtension management = new CentralDogmaExtension() { | ||
| @Override | ||
| protected void configure(CentralDogmaBuilder builder) { | ||
| builder.management(new ManagementConfig((String) null, null, 0, null)); | ||
| } | ||
| }; | ||
|
|
||
| @RegisterExtension | ||
| static final CentralDogmaExtension managementWithFullOptions = new CentralDogmaExtension() { | ||
| @Override | ||
| protected void configure(CentralDogmaBuilder builder) { | ||
| tlsPort = PortUtil.unusedTcpPort(); | ||
| builder.management( | ||
| new ManagementConfig(SessionProtocol.HTTPS, "127.0.0.1", tlsPort, "/custom/management")); | ||
| } | ||
| }; | ||
|
|
||
| @Test | ||
| void disableManagementServiceByDefault() { | ||
| final BlockingWebClient client = noManagement.blockingHttpClient(); | ||
| assertThat(client.get("/internal/management").status()).isEqualTo(HttpStatus.NOT_FOUND); | ||
| } | ||
|
|
||
| @Test | ||
| void managementServiceWithDefaultOption() { | ||
| final BlockingWebClient client = management.blockingHttpClient(); | ||
| final AggregatedHttpResponse response = client.get("/internal/management/jvm/threaddump"); | ||
| assertThat(response.status()).isEqualTo(HttpStatus.OK); | ||
| assertThat(response.contentUtf8()).contains("repository-worker-"); | ||
| } | ||
|
|
||
| @Test | ||
| void managementServiceWithFullOptions() { | ||
| final BlockingWebClient client = | ||
| WebClient.builder("https://127.0.0.1:" + tlsPort) | ||
| .factory(ClientFactory.insecure()) | ||
| .build() | ||
| .blocking(); | ||
| final AggregatedHttpResponse response = client.get("/custom/management/jvm/threaddump"); | ||
| assertThat(response.status()).isEqualTo(HttpStatus.OK); | ||
| assertThat(response.contentUtf8()).contains("repository-worker-"); | ||
| } | ||
|
|
||
| @Test | ||
| void testJsonDeserialization() throws JsonProcessingException { | ||
| final String json = | ||
| '{' + | ||
| "\"protocol\":\"https\"," + | ||
| "\"address\":\"127.0.0.1\"," + | ||
| "\"port\":8443," + | ||
| "\"path\":\"/custom/management\"" + | ||
| '}'; | ||
| final ManagementConfig managementConfig = Jackson.readValue(json, ManagementConfig.class); | ||
|
|
||
| assertThat(managementConfig.protocol()).isEqualTo(SessionProtocol.HTTPS); | ||
| assertThat(managementConfig.port()).isEqualTo(8443); | ||
| assertThat(managementConfig.address()).isEqualTo("127.0.0.1"); | ||
| assertThat(managementConfig.path()).isEqualTo("/custom/management"); | ||
| } | ||
| } |
Oops, something went wrong.