Retrieve diagnostics (for review purpose) #14
There are no files selected for viewing
This file contains hidden or 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 hidden or 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 hidden or 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,145 @@ | ||
| // 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.cloudstack.api.command.admin.diagnostics; | ||
|
|
||
| import com.cloud.exception.InsufficientCapacityException; | ||
| import com.cloud.exception.InvalidParameterValueException; | ||
| import com.cloud.exception.ResourceUnavailableException; | ||
| import com.cloud.vm.VirtualMachine; | ||
| import org.apache.cloudstack.acl.RoleType; | ||
| import org.apache.cloudstack.api.APICommand; | ||
| import org.apache.cloudstack.api.ApiArgValidator; | ||
| import org.apache.cloudstack.api.ApiConstants; | ||
| import org.apache.cloudstack.api.ApiErrorCode; | ||
| import org.apache.cloudstack.api.BaseAsyncCmd; | ||
| import org.apache.cloudstack.api.Parameter; | ||
| import org.apache.cloudstack.api.ServerApiException; | ||
| import org.apache.cloudstack.api.response.RetrieveDiagnosticsResponse; | ||
| import org.apache.cloudstack.api.response.SystemVmResponse; | ||
| import org.apache.cloudstack.context.CallContext; | ||
| import org.apache.cloudstack.diagnostics.RetrieveDiagnosticsService; | ||
| import org.apache.log4j.Logger; | ||
|
|
||
| import javax.inject.Inject; | ||
| import javax.naming.ConfigurationException; | ||
|
|
||
| @APICommand(name = RetrieveDiagnosticsCmd.APINAME, | ||
| description = "Retrieves diagnostics files from host VMs", | ||
| responseObject = RetrieveDiagnosticsResponse.class, | ||
| entityType = {VirtualMachine.class}, | ||
| requestHasSensitiveInfo = false, | ||
| responseHasSensitiveInfo = false, | ||
| since = "4.12.0", | ||
| authorized = {RoleType.Admin}) | ||
| public class RetrieveDiagnosticsCmd extends BaseAsyncCmd { | ||
|
|
||
| private static final Logger LOGGER = Logger.getLogger(RetrieveDiagnosticsCmd.class); | ||
|
|
||
| public static final String APINAME = "retrieveDiagnostics"; | ||
|
|
||
| @Inject | ||
| private RetrieveDiagnosticsService retrieveDiagnosticsService; | ||
|
|
||
| ///////////////////////////////////////////////////// | ||
| //////////////// API parameters ///////////////////// | ||
| ///////////////////////////////////////////////////// | ||
| @Parameter(name = ApiConstants.TARGET_ID, | ||
| type = CommandType.UUID, | ||
| entityType = SystemVmResponse.class, | ||
| validations = {ApiArgValidator.PositiveNumber}, | ||
| required = true, | ||
| description = "the Id of the system VM instance.") | ||
| private Long systemVmId; | ||
|
|
||
|
|
||
| @Parameter(name = ApiConstants.TYPE, | ||
| type = CommandType.STRING, | ||
| required = true, | ||
| description = "The type of diagnostics files requested, if DIAGNOSTICS_TYPE is not provided then the default files specified in the database will be retrieved") | ||
| private String type; | ||
|
|
||
| @Parameter(name = ApiConstants.DETAIL, | ||
| type = CommandType.STRING, | ||
| description = "Optional comma separated list of diagnostics files or items, can be specified as filenames only or full file path. These come in addition to the defaults set in diagnosticstype") | ||
| private String optionalListOfFiles; | ||
|
|
||
| @Parameter(name = ApiConstants.TIMEOUT, | ||
| type = CommandType.STRING, | ||
| description = "Time out setting in seconds for the overall API call.") | ||
| private String timeOut; | ||
|
|
||
| ///////////////////////////////////////////////////// | ||
| /////////////////// Accessors /////////////////////// | ||
| ///////////////////////////////////////////////////// | ||
|
|
||
| public String getOptionalListOfFiles() { | ||
| return optionalListOfFiles; | ||
| } | ||
|
|
||
| public String getTimeOut() { | ||
| return timeOut; | ||
| } | ||
|
|
||
| public Long getId() { | ||
| return systemVmId; | ||
| } | ||
|
|
||
| @Override | ||
| public String getEventType() { | ||
| VirtualMachine.Type type = _mgr.findSystemVMTypeById(getId()); | ||
| return type.toString(); | ||
| } | ||
| public String getType() { | ||
| return type; | ||
| } | ||
|
|
||
| @Override | ||
| public String getCommandName() { | ||
| return APINAME.toLowerCase() + BaseAsyncCmd.RESPONSE_SUFFIX; | ||
| } | ||
|
|
||
| @Override | ||
| public long getEntityOwnerId() { | ||
| return CallContext.current().getCallingAccount().getId(); | ||
| } | ||
|
|
||
| @Override | ||
| public String getEventDescription() { | ||
| return "Retrieved diagnostics files from host =" + systemVmId; | ||
| } | ||
|
|
||
| @Override | ||
| public void execute() throws ResourceUnavailableException, InsufficientCapacityException, ServerApiException { | ||
| CallContext.current().setEventDetails("Vm Id: " + this._uuidMgr.getUuid(VirtualMachine.class, getId())); | ||
| RetrieveDiagnosticsResponse response = new RetrieveDiagnosticsResponse(); | ||
|
|
||
| try { | ||
| final String url = retrieveDiagnosticsService.getDiagnosticsFiles(this); | ||
| response.setUrl(url); | ||
| response.setObjectName("retrieved information"); | ||
| response.setResponseName(getCommandName()); | ||
| this.setResponseObject(response); | ||
| } catch (InvalidParameterValueException ipve) { | ||
| LOGGER.error("Failed to retrieve diagnostics files from ", ipve); | ||
| throw new ServerApiException(ApiErrorCode.PARAM_ERROR, ipve.getMessage()); | ||
| } catch (ConfigurationException cre) { | ||
| LOGGER.error("Failed to retrieve diagnostics files from ", cre); | ||
| throw new ServerApiException(ApiErrorCode.INTERNAL_ERROR, cre.getMessage()); | ||
| } | ||
| } | ||
| } |
This file contains hidden or 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,41 @@ | ||
| // 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.cloudstack.api.response; | ||
|
|
||
| import com.cloud.serializer.Param; | ||
| import com.cloud.vm.VirtualMachine; | ||
| import com.google.gson.annotations.SerializedName; | ||
| import org.apache.cloudstack.api.ApiConstants; | ||
| import org.apache.cloudstack.api.BaseResponse; | ||
| import org.apache.cloudstack.api.EntityReference; | ||
|
|
||
| @EntityReference(value = VirtualMachine.class) | ||
| public class RetrieveDiagnosticsResponse extends BaseResponse { | ||
| @SerializedName(ApiConstants.URL) | ||
| @Param(description = "Secondary storage URL were files have been downloaded to") | ||
| private String url; | ||
|
|
||
|
|
||
| public String getUrl() { | ||
| return url; | ||
| } | ||
|
|
||
| public void setUrl(String url) { | ||
| this.url = url; | ||
| } | ||
| } |
This file contains hidden or 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,44 @@ | ||
| // 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.cloudstack.diagnostics; | ||
|
|
||
| import com.cloud.agent.api.Command; | ||
| import com.cloud.agent.api.to.DataStoreTO; | ||
|
|
||
| public class DeleteZipCommand extends Command { | ||
| private String zipFile; | ||
|
There was a problem hiding this comment. maybe name it zipFileName? |
||
| private DataStoreTO destStore; | ||
|
|
||
| public DeleteZipCommand(DataStoreTO destStore) { | ||
| this.zipFile = zipFile; | ||
| this.destStore = destStore; | ||
| } | ||
|
|
||
| @Override | ||
| public boolean executeInSequence() { | ||
| return false; | ||
| } | ||
|
|
||
| public DataStoreTO getDestStore() { | ||
| return destStore; | ||
| } | ||
|
|
||
| public String getDiagnosticsZipFile() { | ||
| return zipFile; | ||
| } | ||
|
|
||
| } | ||
This file contains hidden or 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,38 @@ | ||
| // 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.cloudstack.diagnostics; | ||
|
|
||
| import com.cloud.exception.InvalidParameterValueException; | ||
| import com.cloud.utils.component.Manager; | ||
| import com.cloud.utils.component.PluggableService; | ||
| import org.apache.cloudstack.api.command.admin.diagnostics.RetrieveDiagnosticsCmd; | ||
| import org.apache.cloudstack.framework.config.impl.DiagnosticsKey; | ||
|
|
||
| import javax.naming.ConfigurationException; | ||
| import java.util.List; | ||
| import java.util.Map; | ||
|
|
||
|
|
||
| public interface RetrieveDiagnosticsService extends Manager, PluggableService { | ||
|
|
||
| String getDiagnosticsFiles(final RetrieveDiagnosticsCmd cmd) throws InvalidParameterValueException, ConfigurationException; | ||
|
|
||
| boolean configure(final String name, final Map<String, Object> params) throws ConfigurationException; | ||
|
There was a problem hiding this comment. should this be in the interface? There was a problem hiding this comment. Charles, why is this in the interface? |
||
|
|
||
| List<DiagnosticsKey> get(String key); | ||
| } | ||
This file contains hidden or 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 hidden or 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,34 @@ | ||
| package com.cloud.agent.api; | ||
|
|
||
| import com.cloud.agent.api.routing.NetworkElementCommand; | ||
| import org.apache.log4j.Logger; | ||
|
|
||
| public class ExecuteScriptCommand extends NetworkElementCommand { | ||
| private static final Logger LOGGER = Logger.getLogger(ExecuteScriptCommand.class); | ||
|
|
||
| private String commandScript; | ||
| private final boolean executeInSequence; | ||
|
|
||
| public ExecuteScriptCommand(String commandScript, boolean executeInSequence) { | ||
| this.commandScript = commandScript; | ||
| this.executeInSequence = executeInSequence; | ||
| } | ||
|
|
||
|
|
||
| @Override | ||
| public boolean executeInSequence() | ||
| { | ||
| return this.executeInSequence; | ||
| } | ||
|
|
||
| @Override | ||
| public boolean isQuery() { | ||
|
|
||
| return true; | ||
| } | ||
|
|
||
| public String getCommandScript() { | ||
| return commandScript; | ||
| } | ||
|
|
||
| } |
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I know it is not custm in cloudstack but can you add some documentation?
i.e: